A Discrete-Event Network Simulator
API
 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 NS_LOG_COMPONENT_DEFINE ("SimpleDeviceEnergyModel");
28 
29 namespace ns3 {
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  .AddConstructor<SimpleDeviceEnergyModel> ()
39  .AddTraceSource ("TotalEnergyConsumption",
40  "Total energy consumption of the radio device.",
41  MakeTraceSourceAccessor (&SimpleDeviceEnergyModel::m_totalEnergyConsumption))
42  ;
43  return tid;
44 }
45 
46 SimpleDeviceEnergyModel::SimpleDeviceEnergyModel ()
47 {
48  NS_LOG_FUNCTION (this);
49  m_lastUpdateTime = Seconds (0.0);
50  m_actualCurrentA = 0.0;
51  m_source = 0;
52 }
53 
54 SimpleDeviceEnergyModel::~SimpleDeviceEnergyModel ()
55 {
56  NS_LOG_FUNCTION (this);
57 }
58 
59 void
60 SimpleDeviceEnergyModel::SetEnergySource (Ptr<EnergySource> source)
61 {
62  NS_LOG_FUNCTION (this << source);
63  NS_ASSERT (source != NULL);
64  m_source = source;
65 }
66 
67 void
68 SimpleDeviceEnergyModel::SetNode (Ptr<Node> node)
69 {
70  NS_LOG_FUNCTION (this << node);
71  NS_ASSERT (node != NULL);
72  m_node = node;
73 }
74 
75 Ptr<Node>
76 SimpleDeviceEnergyModel::GetNode () const
77 {
78  NS_LOG_FUNCTION (this);
79  return m_node;
80 }
81 
82 double
83 SimpleDeviceEnergyModel::GetTotalEnergyConsumption (void) const
84 {
85  NS_LOG_FUNCTION (this);
86  return m_totalEnergyConsumption;
87 }
88 
89 void
90 SimpleDeviceEnergyModel::SetCurrentA (double current)
91 {
92  NS_LOG_FUNCTION (this << current);
93  Time duration = Simulator::Now () - m_lastUpdateTime;
94 
95  double energyToDecrease = 0.0;
96  double supplyVoltage = m_source->GetSupplyVoltage ();
97  energyToDecrease = duration.GetSeconds () * current * supplyVoltage;
98 
99  // update total energy consumption
100  m_totalEnergyConsumption += energyToDecrease;
101  // update last update time stamp
102  m_lastUpdateTime = Simulator::Now ();
103  // notify energy source
104  m_source->UpdateEnergySource ();
105  // update the current drain
106  m_actualCurrentA = current;
107 }
108 
109 void
110 SimpleDeviceEnergyModel::DoDispose (void)
111 {
112  NS_LOG_FUNCTION (this);
113  m_source = 0;
114 }
115 
116 double
117 SimpleDeviceEnergyModel::DoGetCurrentA (void) const
118 {
119  NS_LOG_FUNCTION (this);
120  return m_actualCurrentA;
121 }
122 
123 } // namespace ns3