A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
Loading...
Searching...
No Matches
device-energy-model.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2010 Network Security Lab, University of Washington, Seattle.
3
*
4
* This program is free software; you can redistribute it and/or modify
5
* it under the terms of the GNU General Public License version 2 as
6
* published by the Free Software Foundation;
7
*
8
* This program is distributed in the hope that it will be useful,
9
* but WITHOUT ANY WARRANTY; without even the implied warranty of
10
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
* GNU General Public License for more details.
12
*
13
* You should have received a copy of the GNU General Public License
14
* along with this program; if not, write to the Free Software
15
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
*
17
* Authors: Sidharth Nabar <snabar@uw.edu>, He Wu <mdzz@u.washington.edu>
18
*/
19
20
#ifndef DEVICE_ENERGY_MODEL_H
21
#define DEVICE_ENERGY_MODEL_H
22
23
#include "ns3/node.h"
24
#include "ns3/object.h"
25
#include "ns3/ptr.h"
26
#include "ns3/type-id.h"
27
28
namespace
ns3
29
{
30
31
class
EnergySource;
32
33
/**
34
* \ingroup energy
35
* \brief Base class for device energy models.
36
*
37
* A device energy model should represent the energy consumption behavior of a
38
* specific device. It will update remaining energy stored in the EnergySource
39
* object installed on node. When energy is depleted, each DeviceEnergyModel
40
* object installed on the same node will be informed by the EnergySource.
41
*
42
*/
43
class
DeviceEnergyModel
:
public
Object
44
{
45
public
:
46
/**
47
* Callback type for ChangeState function. Devices uses this state to notify
48
* DeviceEnergyModel of a state change.
49
*/
50
typedef
Callback<void, int>
ChangeStateCallback
;
51
52
public
:
53
/**
54
* \brief Get the type ID.
55
* \return The object TypeId.
56
*/
57
static
TypeId
GetTypeId
();
58
DeviceEnergyModel
();
59
~DeviceEnergyModel
()
override
;
60
61
/**
62
* \param source Pointer to energy source installed on node.
63
*
64
* This function sets the pointer to energy source installed on node. Should
65
* be called only by DeviceEnergyModel helper classes.
66
*/
67
virtual
void
SetEnergySource
(
Ptr<EnergySource>
source) = 0;
68
69
/**
70
* \returns Total energy consumption of the device.
71
*
72
* DeviceEnergyModel records its own energy consumption during simulation.
73
*/
74
virtual
double
GetTotalEnergyConsumption
()
const
= 0;
75
76
/**
77
* \param newState New state the device is in.
78
*
79
* DeviceEnergyModel is a state based model. This function is implemented by
80
* all child of DeviceEnergyModel to change the model's state. States are to
81
* be defined by each child using an enum (int).
82
*/
83
virtual
void
ChangeState
(
int
newState) = 0;
84
85
/**
86
* \returns Current draw of the device, in Ampere.
87
*
88
* This function returns the current draw at the device in its current state.
89
* This function is called from the EnergySource to obtain the total current
90
* draw at any given time during simulation.
91
*/
92
double
GetCurrentA
()
const
;
93
94
/**
95
* This function is called by the EnergySource object when energy stored in
96
* the energy source is depleted. Should be implemented by child classes.
97
*/
98
virtual
void
HandleEnergyDepletion
() = 0;
99
100
/**
101
* This function is called by the EnergySource object when energy stored in
102
* the energy source is recharged. Should be implemented by child classes.
103
*/
104
virtual
void
HandleEnergyRecharged
() = 0;
105
106
/**
107
* This function is called by the EnergySource object when energy stored in
108
* the energy source is changed. Should be implemented by child classes.
109
*/
110
virtual
void
HandleEnergyChanged
() = 0;
111
112
private
:
113
/**
114
* \returns 0.0 as the current value, in Ampere.
115
*
116
* Child class does not have to implement this method if current draw for its
117
* states are not know. This default method will always return 0.0A. For the
118
* devices who does know the current draw of its states, this method must be
119
* overwritten.
120
*/
121
virtual
double
DoGetCurrentA
()
const
;
122
};
123
124
}
// namespace ns3
125
126
#endif
/* DEVICE_ENERGY_MODEL_H */
ns3::Callback
Callback template class.
Definition:
callback.h:438
ns3::DeviceEnergyModel
Base class for device energy models.
Definition:
device-energy-model.h:44
ns3::DeviceEnergyModel::GetTotalEnergyConsumption
virtual double GetTotalEnergyConsumption() const =0
ns3::DeviceEnergyModel::DoGetCurrentA
virtual double DoGetCurrentA() const
Definition:
device-energy-model.cc:60
ns3::DeviceEnergyModel::HandleEnergyChanged
virtual void HandleEnergyChanged()=0
This function is called by the EnergySource object when energy stored in the energy source is changed...
ns3::DeviceEnergyModel::ChangeStateCallback
Callback< void, int > ChangeStateCallback
Callback type for ChangeState function.
Definition:
device-energy-model.h:50
ns3::DeviceEnergyModel::DeviceEnergyModel
DeviceEnergyModel()
Definition:
device-energy-model.cc:38
ns3::DeviceEnergyModel::SetEnergySource
virtual void SetEnergySource(Ptr< EnergySource > source)=0
ns3::DeviceEnergyModel::GetCurrentA
double GetCurrentA() const
Definition:
device-energy-model.cc:49
ns3::DeviceEnergyModel::ChangeState
virtual void ChangeState(int newState)=0
ns3::DeviceEnergyModel::~DeviceEnergyModel
~DeviceEnergyModel() override
Definition:
device-energy-model.cc:43
ns3::DeviceEnergyModel::HandleEnergyRecharged
virtual void HandleEnergyRecharged()=0
This function is called by the EnergySource object when energy stored in the energy source is recharg...
ns3::DeviceEnergyModel::HandleEnergyDepletion
virtual void HandleEnergyDepletion()=0
This function is called by the EnergySource object when energy stored in the energy source is deplete...
ns3::DeviceEnergyModel::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
device-energy-model.cc:32
ns3::Object
A base class which provides memory management and object aggregation.
Definition:
object.h:89
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition:
ptr.h:77
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:59
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
energy
model
device-energy-model.h
Generated on Tue Apr 23 2024 19:07:09 for ns-3 by
1.9.6