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
simple-device-energy-model.cc
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
#include "ns3/simulator.h"
22
#include "ns3/trace-source-accessor.h"
23
#include "ns3/energy-source.h"
24
#include "
simple-device-energy-model.h
"
25
#include "ns3/log.h"
26
27
namespace
ns3 {
28
29
NS_LOG_COMPONENT_DEFINE
(
"SimpleDeviceEnergyModel"
);
30
31
NS_OBJECT_ENSURE_REGISTERED
(SimpleDeviceEnergyModel);
32
33
TypeId
34
SimpleDeviceEnergyModel::GetTypeId
(
void
)
35
{
36
static
TypeId
tid =
TypeId
(
"ns3::SimpleDeviceEnergyModel"
)
37
.
SetParent
<
DeviceEnergyModel
> ()
38
.SetGroupName (
"Energy"
)
39
.AddConstructor<
SimpleDeviceEnergyModel
> ()
40
.AddTraceSource (
"TotalEnergyConsumption"
,
41
"Total energy consumption of the radio device."
,
42
MakeTraceSourceAccessor
(&
SimpleDeviceEnergyModel::m_totalEnergyConsumption
),
43
"ns3::TracedValueCallback::Double"
)
44
;
45
return
tid;
46
}
47
48
SimpleDeviceEnergyModel::SimpleDeviceEnergyModel
()
49
{
50
NS_LOG_FUNCTION
(
this
);
51
m_lastUpdateTime
=
Seconds
(0.0);
52
m_actualCurrentA
= 0.0;
53
m_source
= 0;
54
}
55
56
SimpleDeviceEnergyModel::~SimpleDeviceEnergyModel
()
57
{
58
NS_LOG_FUNCTION
(
this
);
59
}
60
61
void
62
SimpleDeviceEnergyModel::SetEnergySource
(
Ptr<EnergySource>
source)
63
{
64
NS_LOG_FUNCTION
(
this
<< source);
65
NS_ASSERT
(source != NULL);
66
m_source
= source;
67
}
68
69
void
70
SimpleDeviceEnergyModel::SetNode
(
Ptr<Node>
node)
71
{
72
NS_LOG_FUNCTION
(
this
<< node);
73
NS_ASSERT
(node != NULL);
74
m_node
= node;
75
}
76
77
Ptr<Node>
78
SimpleDeviceEnergyModel::GetNode
()
const
79
{
80
NS_LOG_FUNCTION
(
this
);
81
return
m_node
;
82
}
83
84
double
85
SimpleDeviceEnergyModel::GetTotalEnergyConsumption
(
void
)
const
86
{
87
NS_LOG_FUNCTION
(
this
);
88
return
m_totalEnergyConsumption
;
89
}
90
91
void
92
SimpleDeviceEnergyModel::SetCurrentA
(
double
current)
93
{
94
NS_LOG_FUNCTION
(
this
<< current);
95
Time
duration =
Simulator::Now
() -
m_lastUpdateTime
;
96
97
double
energyToDecrease = 0.0;
98
double
supplyVoltage =
m_source
->GetSupplyVoltage ();
99
energyToDecrease = duration.
GetSeconds
() * current * supplyVoltage;
100
101
// update total energy consumption
102
m_totalEnergyConsumption
+= energyToDecrease;
103
// update last update time stamp
104
m_lastUpdateTime
=
Simulator::Now
();
105
// notify energy source
106
m_source
->UpdateEnergySource ();
107
// update the current drain
108
m_actualCurrentA
= current;
109
}
110
111
void
112
SimpleDeviceEnergyModel::DoDispose
(
void
)
113
{
114
NS_LOG_FUNCTION
(
this
);
115
m_source
= 0;
116
}
117
118
double
119
SimpleDeviceEnergyModel::DoGetCurrentA
(
void
)
const
120
{
121
NS_LOG_FUNCTION
(
this
);
122
return
m_actualCurrentA
;
123
}
124
125
}
// namespace ns3
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition:
nstime.h:102
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition:
ptr.h:73
NS_LOG_FUNCTION
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
Definition:
log-macros-enabled.h:213
ns3::SimpleDeviceEnergyModel::m_source
Ptr< EnergySource > m_source
Definition:
simple-device-energy-model.h:124
NS_OBJECT_ENSURE_REGISTERED
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition:
object-base.h:44
ns3::DeviceEnergyModel
Base class for device energy models.
Definition:
device-energy-model.h:43
NS_ASSERT
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition:
assert.h:67
NS_LOG_COMPONENT_DEFINE
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition:
log.h:201
ns3::SimpleDeviceEnergyModel::SetEnergySource
virtual void SetEnergySource(Ptr< EnergySource > source)
Sets pointer to EnergySouce installed on node.
Definition:
simple-device-energy-model.cc:62
ns3::MakeTraceSourceAccessor
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
Definition:
trace-source-accessor.h:185
ns3::Time::GetSeconds
double GetSeconds(void) const
Get an approximation of the time stored in this instance in the indicated unit.
Definition:
nstime.h:341
ns3::SimpleDeviceEnergyModel::SetCurrentA
void SetCurrentA(double current)
Definition:
simple-device-energy-model.cc:92
ns3::SimpleDeviceEnergyModel::m_node
Ptr< Node > m_node
Definition:
simple-device-energy-model.h:125
ns3::SimpleDeviceEnergyModel::~SimpleDeviceEnergyModel
virtual ~SimpleDeviceEnergyModel()
Definition:
simple-device-energy-model.cc:56
ns3::SimpleDeviceEnergyModel
A simple device energy model where current drain can be set by the user.
Definition:
simple-device-energy-model.h:38
ns3::SimpleDeviceEnergyModel::GetTypeId
static TypeId GetTypeId(void)
Definition:
simple-device-energy-model.cc:34
ns3::SimpleDeviceEnergyModel::SimpleDeviceEnergyModel
SimpleDeviceEnergyModel()
Definition:
simple-device-energy-model.cc:48
ns3::SimpleDeviceEnergyModel::m_totalEnergyConsumption
TracedValue< double > m_totalEnergyConsumption
Definition:
simple-device-energy-model.h:126
ns3::SimpleDeviceEnergyModel::GetTotalEnergyConsumption
virtual double GetTotalEnergyConsumption(void) const
Definition:
simple-device-energy-model.cc:85
ns3::SimpleDeviceEnergyModel::DoDispose
void DoDispose(void)
Destructor implementation.
Definition:
simple-device-energy-model.cc:112
simple-device-energy-model.h
ns3::Simulator::Now
static Time Now(void)
Return the current simulation virtual time.
Definition:
simulator.cc:223
ns3::SimpleDeviceEnergyModel::m_actualCurrentA
double m_actualCurrentA
Definition:
simple-device-energy-model.h:123
ns3::SimpleDeviceEnergyModel::m_lastUpdateTime
Time m_lastUpdateTime
Definition:
simple-device-energy-model.h:122
ns3::Seconds
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition:
nstime.h:895
ns3::SimpleDeviceEnergyModel::DoGetCurrentA
virtual double DoGetCurrentA(void) const
Definition:
simple-device-energy-model.cc:119
ns3::SimpleDeviceEnergyModel::SetNode
virtual void SetNode(Ptr< Node > node)
Sets pointer to node.
Definition:
simple-device-energy-model.cc:70
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:58
ns3::TypeId::SetParent
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition:
type-id.cc:827
ns3::SimpleDeviceEnergyModel::GetNode
virtual Ptr< Node > GetNode(void) const
Gets pointer to node.
Definition:
simple-device-energy-model.cc:78
src
energy
model
simple-device-energy-model.cc
Generated on Wed Jul 6 2016 17:11:28 for ns-3 by
1.8.6