A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Portuguese
Docs ▼
Wiki
Manual
Models
Develop ▼
API
Bugs
API
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Properties
Friends
Macros
Groups
Pages
acoustic-modem-energy-model.h
Go to the documentation of this file.
1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2
/*
3
* Copyright (c) 2010 Andrea Sacco
4
*
5
* This program is free software; you can redistribute it and/or modify
6
* it under the terms of the GNU General Public License version 2 as
7
* published by the Free Software Foundation;
8
*
9
* This program is distributed in the hope that it will be useful,
10
* but WITHOUT ANY WARRANTY; without even the implied warranty of
11
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
* GNU General Public License for more details.
13
*
14
* You should have received a copy of the GNU General Public License
15
* along with this program; if not, write to the Free Software
16
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
*
18
* Author: Andrea Sacco <andrea.sacco85@gmail.com>
19
*/
20
21
#ifndef ACOUSTIC_MODEM_ENERGY_MODEL_H
22
#define ACOUSTIC_MODEM_ENERGY_MODEL_H
23
24
#include "ns3/device-energy-model.h"
25
#include "ns3/nstime.h"
26
#include "ns3/event-id.h"
27
#include "ns3/traced-value.h"
28
29
namespace
ns3 {
30
52
class
AcousticModemEnergyModel
:
public
DeviceEnergyModel
53
{
54
public
:
58
typedef
Callback<void>
AcousticModemEnergyDepletionCallback
;
59
60
public
:
61
static
TypeId
GetTypeId
(
void
);
62
AcousticModemEnergyModel
();
63
virtual
~AcousticModemEnergyModel
();
64
72
virtual
void
SetNode
(
Ptr<Node>
node);
73
81
virtual
Ptr<Node>
GetNode
(
void
)
const
;
82
90
virtual
void
SetEnergySource
(
Ptr<EnergySource>
source);
91
97
virtual
double
GetTotalEnergyConsumption
(
void
)
const
;
98
103
double
GetTxPowerW
(
void
)
const
;
104
110
void
SetTxPowerW
(
double
txPowerW);
111
116
double
GetRxPowerW
(
void
)
const
;
117
123
void
SetRxPowerW
(
double
rxPowerW);
124
129
double
GetIdlePowerW
(
void
)
const
;
130
136
void
SetIdlePowerW
(
double
idlePowerW);
137
142
double
GetSleepPowerW
(
void
)
const
;
143
149
void
SetSleepPowerW
(
double
sleepPowerW);
150
154
int
GetCurrentState
(
void
)
const
;
155
161
void
SetEnergyDepletionCallback
(
AcousticModemEnergyDepletionCallback
callback);
162
170
virtual
void
ChangeState
(
int
newState);
171
177
virtual
void
HandleEnergyDepletion
(
void
);
178
179
180
private
:
181
void
DoDispose
(
void
);
182
188
virtual
double
DoGetCurrentA
(
void
)
const
;
189
196
bool
IsStateTransitionValid
(
const
int
destState);
197
204
void
SetMicroModemState
(
const
int
state);
205
206
private
:
207
Ptr<Node>
m_node
;
208
Ptr<EnergySource>
m_source
;
209
210
// Member variables for power consumption in different modem states.
211
double
m_txPowerW
;
212
double
m_rxPowerW
;
213
double
m_idlePowerW
;
214
double
m_sleepPowerW
;
215
216
// This variable keeps track of the total energy consumed by this model.
217
TracedValue<double>
m_totalEnergyConsumption
;
218
219
// State variables.
220
int
m_currentState
;
// current state the modem is in
221
Time
m_lastUpdateTime
;
// time stamp of previous energy update
222
223
// energy depletion callback
224
AcousticModemEnergyDepletionCallback
m_energyDepletionCallback
;
225
};
226
227
}
// namespace ns3
228
229
#endif
/* ACOUSTIC_MODEM_ENERGY_MODEL_H */
ns3::AcousticModemEnergyModel::GetRxPowerW
double GetRxPowerW(void) const
Definition:
acoustic-modem-energy-model.cc:131
ns3::AcousticModemEnergyModel::ChangeState
virtual void ChangeState(int newState)
Changes state of the AcousticModemEnergyModel.
Definition:
acoustic-modem-energy-model.cc:192
ns3::AcousticModemEnergyModel::AcousticModemEnergyModel
AcousticModemEnergyModel()
Definition:
acoustic-modem-energy-model.cc:73
ns3::Time
keep track of time values and allow control of global simulation resolution
Definition:
nstime.h:81
ns3::AcousticModemEnergyModel::~AcousticModemEnergyModel
virtual ~AcousticModemEnergyModel()
Definition:
acoustic-modem-energy-model.cc:83
ns3::Ptr< Node >
ns3::AcousticModemEnergyModel::HandleEnergyDepletion
virtual void HandleEnergyDepletion(void)
Handles energy depletion.
Definition:
acoustic-modem-energy-model.cc:239
ns3::AcousticModemEnergyModel::DoGetCurrentA
virtual double DoGetCurrentA(void) const
Definition:
acoustic-modem-energy-model.cc:268
ns3::Callback< void >
ns3::AcousticModemEnergyModel::m_idlePowerW
double m_idlePowerW
Definition:
acoustic-modem-energy-model.h:213
ns3::DeviceEnergyModel
Base class for device energy models.
Definition:
device-energy-model.h:43
ns3::AcousticModemEnergyModel::GetTotalEnergyConsumption
virtual double GetTotalEnergyConsumption(void) const
Definition:
acoustic-modem-energy-model.cc:110
ns3::AcousticModemEnergyModel::m_rxPowerW
double m_rxPowerW
Definition:
acoustic-modem-energy-model.h:212
ns3::AcousticModemEnergyModel::m_energyDepletionCallback
AcousticModemEnergyDepletionCallback m_energyDepletionCallback
Definition:
acoustic-modem-energy-model.h:224
ns3::AcousticModemEnergyModel::SetIdlePowerW
void SetIdlePowerW(double idlePowerW)
Definition:
acoustic-modem-energy-model.cc:152
ns3::AcousticModemEnergyModel::IsStateTransitionValid
bool IsStateTransitionValid(const int destState)
Definition:
acoustic-modem-energy-model.cc:297
ns3::AcousticModemEnergyModel::m_node
Ptr< Node > m_node
Definition:
acoustic-modem-energy-model.h:207
ns3::TracedValue< double >
ns3::AcousticModemEnergyModel::SetEnergyDepletionCallback
void SetEnergyDepletionCallback(AcousticModemEnergyDepletionCallback callback)
Definition:
acoustic-modem-energy-model.cc:180
ns3::AcousticModemEnergyModel
WHOI micro-modem energy model.
Definition:
acoustic-modem-energy-model.h:52
ns3::AcousticModemEnergyModel::m_sleepPowerW
double m_sleepPowerW
Definition:
acoustic-modem-energy-model.h:214
ns3::AcousticModemEnergyModel::AcousticModemEnergyDepletionCallback
Callback< void > AcousticModemEnergyDepletionCallback
Definition:
acoustic-modem-energy-model.h:58
ns3::AcousticModemEnergyModel::SetTxPowerW
void SetTxPowerW(double txPowerW)
Definition:
acoustic-modem-energy-model.cc:124
ns3::AcousticModemEnergyModel::SetRxPowerW
void SetRxPowerW(double rxPowerW)
Definition:
acoustic-modem-energy-model.cc:138
ns3::AcousticModemEnergyModel::SetEnergySource
virtual void SetEnergySource(Ptr< EnergySource > source)
Sets pointer to EnergySouce installed on node.
Definition:
acoustic-modem-energy-model.cc:102
ns3::AcousticModemEnergyModel::GetTypeId
static TypeId GetTypeId(void)
Definition:
acoustic-modem-energy-model.cc:37
ns3::AcousticModemEnergyModel::m_currentState
int m_currentState
Definition:
acoustic-modem-energy-model.h:220
ns3::AcousticModemEnergyModel::m_source
Ptr< EnergySource > m_source
Definition:
acoustic-modem-energy-model.h:208
ns3::AcousticModemEnergyModel::DoDispose
void DoDispose(void)
Definition:
acoustic-modem-energy-model.cc:259
ns3::AcousticModemEnergyModel::GetSleepPowerW
double GetSleepPowerW(void) const
Definition:
acoustic-modem-energy-model.cc:159
ns3::AcousticModemEnergyModel::GetTxPowerW
double GetTxPowerW(void) const
Definition:
acoustic-modem-energy-model.cc:117
ns3::AcousticModemEnergyModel::GetNode
virtual Ptr< Node > GetNode(void) const
Gets pointer to node.
Definition:
acoustic-modem-energy-model.cc:96
ns3::AcousticModemEnergyModel::m_lastUpdateTime
Time m_lastUpdateTime
Definition:
acoustic-modem-energy-model.h:221
ns3::AcousticModemEnergyModel::SetNode
virtual void SetNode(Ptr< Node > node)
Sets pointer to node.
Definition:
acoustic-modem-energy-model.cc:88
ns3::AcousticModemEnergyModel::SetSleepPowerW
void SetSleepPowerW(double sleepPowerW)
Definition:
acoustic-modem-energy-model.cc:166
ns3::AcousticModemEnergyModel::GetCurrentState
int GetCurrentState(void) const
Definition:
acoustic-modem-energy-model.cc:173
ns3::AcousticModemEnergyModel::m_txPowerW
double m_txPowerW
Definition:
acoustic-modem-energy-model.h:211
ns3::AcousticModemEnergyModel::GetIdlePowerW
double GetIdlePowerW(void) const
Definition:
acoustic-modem-energy-model.cc:145
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:49
ns3::AcousticModemEnergyModel::SetMicroModemState
void SetMicroModemState(const int state)
Definition:
acoustic-modem-energy-model.cc:304
ns3::AcousticModemEnergyModel::m_totalEnergyConsumption
TracedValue< double > m_totalEnergyConsumption
Definition:
acoustic-modem-energy-model.h:217
src
uan
model
acoustic-modem-energy-model.h
Generated on Sat Nov 16 2013 16:17:53 for ns-3 by
1.8.5