A Discrete-Event Network Simulator
API
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"
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
35 {
36  static TypeId tid = TypeId ("ns3::SimpleDeviceEnergyModel")
38  .SetGroupName ("Energy")
39  .AddConstructor<SimpleDeviceEnergyModel> ()
40  .AddTraceSource ("TotalEnergyConsumption",
41  "Total energy consumption of the radio device.",
43  "ns3::TracedValueCallback::Double")
44  ;
45  return tid;
46 }
47 
49 {
50  NS_LOG_FUNCTION (this);
51  m_lastUpdateTime = Seconds (0.0);
52  m_actualCurrentA = 0.0;
53  m_source = 0;
54 }
55 
57 {
58  NS_LOG_FUNCTION (this);
59 }
60 
61 void
63 {
64  NS_LOG_FUNCTION (this << source);
65  NS_ASSERT (source != NULL);
66  m_source = source;
67 }
68 
69 void
71 {
72  NS_LOG_FUNCTION (this << node);
73  NS_ASSERT (node != NULL);
74  m_node = node;
75 }
76 
79 {
80  NS_LOG_FUNCTION (this);
81  return m_node;
82 }
83 
84 double
86 {
87  NS_LOG_FUNCTION (this);
88  Time duration = Simulator::Now () - m_lastUpdateTime;
89 
90  double energyToDecrease = 0.0;
91  double supplyVoltage = m_source->GetSupplyVoltage ();
92  energyToDecrease = duration.GetSeconds () * m_actualCurrentA * supplyVoltage;
93 
94  m_source->UpdateEnergySource ();
95 
96  return m_totalEnergyConsumption + energyToDecrease;
97 }
98 
99 void
101 {
102  NS_LOG_FUNCTION (this << current);
103  Time duration = Simulator::Now () - m_lastUpdateTime;
104 
105  double energyToDecrease = 0.0;
106  double supplyVoltage = m_source->GetSupplyVoltage ();
107  energyToDecrease = duration.GetSeconds () * current * supplyVoltage;
108 
109  // update total energy consumption
110  m_totalEnergyConsumption += energyToDecrease;
111  // update last update time stamp
113  // notify energy source
114  m_source->UpdateEnergySource ();
115  // update the current drain
116  m_actualCurrentA = current;
117 }
118 
119 void
121 {
122  NS_LOG_FUNCTION (this);
123  m_source = 0;
124 }
125 
126 double
128 {
129  NS_LOG_FUNCTION (this);
130  return m_actualCurrentA;
131 }
132 
133 } // namespace ns3
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
Base class for device energy models.
double GetSeconds(void) const
Get an approximation of the time stored in this instance in the indicated unit.
Definition: nstime.h:361
#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
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
virtual void SetEnergySource(Ptr< EnergySource > source)
Sets pointer to EnergySouce installed on node.
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
A simple device energy model where current drain can be set by the user.
virtual Ptr< Node > GetNode(void) const
Gets pointer to node.
TracedValue< double > m_totalEnergyConsumption
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual double GetTotalEnergyConsumption(void) const
void DoDispose(void)
Destructor implementation.
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:193
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1070
virtual double DoGetCurrentA(void) const
virtual void SetNode(Ptr< Node > node)
Sets pointer to node.
a unique identifier for an interface.
Definition: type-id.h:58
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:923