A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
basic-energy-source.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2010 Network Security Lab, University of Washington, Seattle.
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  * Authors: Sidharth Nabar <snabar@uw.edu>, He Wu <mdzz@u.washington.edu>
19  */
20 
21 #include "basic-energy-source.h"
22 #include "ns3/log.h"
23 #include "ns3/assert.h"
24 #include "ns3/double.h"
25 #include "ns3/trace-source-accessor.h"
26 #include "ns3/simulator.h"
27 
28 NS_LOG_COMPONENT_DEFINE ("BasicEnergySource");
29 
30 namespace ns3 {
31 
32 NS_OBJECT_ENSURE_REGISTERED (BasicEnergySource);
33 
34 TypeId
36 {
37  static TypeId tid = TypeId ("ns3::BasicEnergySource")
39  .AddConstructor<BasicEnergySource> ()
40  .AddAttribute ("BasicEnergySourceInitialEnergyJ",
41  "Initial energy stored in basic energy source.",
42  DoubleValue (10), // in Joules
43  MakeDoubleAccessor (&BasicEnergySource::SetInitialEnergy,
45  MakeDoubleChecker<double> ())
46  .AddAttribute ("BasicEnergySupplyVoltageV",
47  "Initial supply voltage for basic energy source.",
48  DoubleValue (3.0), // in Volts
49  MakeDoubleAccessor (&BasicEnergySource::SetSupplyVoltage,
51  MakeDoubleChecker<double> ())
52  .AddAttribute ("PeriodicEnergyUpdateInterval",
53  "Time between two consecutive periodic energy updates.",
54  TimeValue (Seconds (1.0)),
57  MakeTimeChecker ())
58  .AddTraceSource ("RemainingEnergy",
59  "Remaining energy at BasicEnergySource.",
61  ;
62  return tid;
63 }
64 
66 {
67  NS_LOG_FUNCTION (this);
68  m_lastUpdateTime = Seconds (0.0);
69 }
70 
72 {
73  NS_LOG_FUNCTION (this);
74 }
75 
76 void
77 BasicEnergySource::SetInitialEnergy (double initialEnergyJ)
78 {
79  NS_LOG_FUNCTION (this << initialEnergyJ);
80  NS_ASSERT (initialEnergyJ >= 0);
81  m_initialEnergyJ = initialEnergyJ;
83 }
84 
85 void
86 BasicEnergySource::SetSupplyVoltage (double supplyVoltageV)
87 {
88  NS_LOG_FUNCTION (this << supplyVoltageV);
89  m_supplyVoltageV = supplyVoltageV;
90 }
91 
92 void
94 {
95  NS_LOG_FUNCTION (this << interval);
96  m_energyUpdateInterval = interval;
97 }
98 
99 Time
101 {
102  NS_LOG_FUNCTION (this);
103  return m_energyUpdateInterval;
104 }
105 
106 double
108 {
109  NS_LOG_FUNCTION (this);
110  return m_supplyVoltageV;
111 }
112 
113 double
115 {
116  NS_LOG_FUNCTION (this);
117  return m_initialEnergyJ;
118 }
119 
120 double
122 {
123  NS_LOG_FUNCTION (this);
124  // update energy source to get the latest remaining energy.
126  return m_remainingEnergyJ;
127 }
128 
129 double
131 {
132  NS_LOG_FUNCTION (this);
133  // update energy source to get the latest remaining energy.
136 }
137 
138 void
140 {
141  NS_LOG_FUNCTION (this);
142  NS_LOG_DEBUG ("BasicEnergySource:Updating remaining energy.");
143 
144  // do not update if simulation has finished
145  if (Simulator::IsFinished ())
146  {
147  return;
148  }
149 
151 
153 
154  if (m_remainingEnergyJ <= 0)
155  {
157  return; // stop periodic update
158  }
159 
161 
164  this);
165 }
166 
167 /*
168  * Private functions start here.
169  */
170 
171 void
173 {
174  NS_LOG_FUNCTION (this);
175  UpdateEnergySource (); // start periodic update
176 }
177 
178 void
180 {
181  NS_LOG_FUNCTION (this);
182  BreakDeviceEnergyModelRefCycle (); // break reference cycle
183 }
184 
185 void
187 {
188  NS_LOG_FUNCTION (this);
189  NS_LOG_DEBUG ("BasicEnergySource:Energy depleted!");
190  NotifyEnergyDrained (); // notify DeviceEnergyModel objects
191  m_remainingEnergyJ = 0; // energy never goes below 0
192 }
193 
194 void
196 {
197  NS_LOG_FUNCTION (this);
198  double totalCurrentA = CalculateTotalCurrent ();
199  Time duration = Simulator::Now () - m_lastUpdateTime;
200  NS_ASSERT (duration.GetSeconds () >= 0);
201  // energy = current * voltage * time
202  double energyToDecreaseJ = totalCurrentA * m_supplyVoltageV * duration.GetSeconds ();
203  m_remainingEnergyJ -= energyToDecreaseJ;
204  NS_LOG_DEBUG ("BasicEnergySource:Remaining energy = " << m_remainingEnergyJ);
205 }
206 
207 } // namespace ns3
void CalculateRemainingEnergy(void)
Calculates remaining energy.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:79
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
Time GetEnergyUpdateInterval(void) const
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register the class in the ns-3 factory.
Definition: object-base.h:38
virtual double GetSupplyVoltage(void) const
Energy source base class.
Definition: energy-source.h:71
virtual double GetRemainingEnergy(void)
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:61
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:170
virtual void UpdateEnergySource(void)
Implements UpdateEnergySource.
static EventId Schedule(Time const &time, MEM mem_ptr, OBJ obj)
Schedule an event to expire at the relative time "time" is reached.
Definition: simulator.h:825
void HandleEnergyDrainedEvent(void)
Handles the remaining energy going to zero event.
void BreakDeviceEnergyModelRefCycle(void)
This function is called to break reference cycle between EnergySource and DeviceEnergyModel.
double GetSeconds(void) const
Definition: nstime.h:272
virtual double GetInitialEnergy(void) const
void DoDispose(void)
Defined in ns3::Object.
hold objects of type ns3::Time
Definition: nstime.h:1008
TracedValue< double > m_remainingEnergyJ
static TypeId GetTypeId(void)
double CalculateTotalCurrent(void)
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
void DoInitialize(void)
Defined in ns3::Object.
static Time Now(void)
Return the "current simulation time".
Definition: simulator.cc:180
void NotifyEnergyDrained(void)
This function notifies all DeviceEnergyModel of energy depletion event.
void SetSupplyVoltage(double supplyVoltageV)
void SetEnergyUpdateInterval(Time interval)
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:213
void Cancel(void)
This method is syntactic sugar for the ns3::Simulator::cancel method.
Definition: event-id.cc:47
static bool IsFinished(void)
If there are no more events lefts to be scheduled, or if simulation time has already reached the "sto...
Definition: simulator.cc:150
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
Definition: time.cc:441
void SetInitialEnergy(double initialEnergyJ)
Hold a floating point type.
Definition: double.h:41
a unique identifier for an interface.
Definition: type-id.h:49
TypeId SetParent(TypeId tid)
Definition: type-id.cc:610
virtual double GetEnergyFraction(void)