A Discrete-Event Network Simulator
API
device-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 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 #ifndef DEVICE_ENERGY_MODEL_H
22 #define DEVICE_ENERGY_MODEL_H
23 
24 #include "ns3/object.h"
25 #include "ns3/ptr.h"
26 #include "ns3/type-id.h"
27 #include "ns3/node.h"
28 
29 namespace ns3 {
30 
31 class EnergySource;
32 
43 class DeviceEnergyModel : public Object
44 {
45 public:
51 
52 public:
57  static TypeId GetTypeId (void);
59  virtual ~DeviceEnergyModel ();
60 
67  virtual void SetEnergySource (Ptr<EnergySource> source) = 0;
68 
74  virtual double GetTotalEnergyConsumption (void) const = 0;
75 
83  virtual void ChangeState (int newState) = 0;
84 
92  double GetCurrentA (void) const;
93 
98  virtual void HandleEnergyDepletion (void) = 0;
99 
104  virtual void HandleEnergyRecharged (void) = 0;
105 
110  virtual void HandleEnergyChanged (void) = 0;
111 
112 
113 private:
122  virtual double DoGetCurrentA (void) const;
123 
124 };
125 
126 }
127 
128 #endif /* DEVICE_ENERGY_MODEL_H */
Base class for device energy models.
Callback< void, int > ChangeStateCallback
Callback type for ChangeState function.
virtual double GetTotalEnergyConsumption(void) const =0
virtual void SetEnergySource(Ptr< EnergySource > source)=0
virtual void ChangeState(int newState)=0
virtual void HandleEnergyChanged(void)=0
This function is called by the EnergySource object when energy stored in the energy source is changed...
virtual double DoGetCurrentA(void) const
virtual void HandleEnergyDepletion(void)=0
This function is called by the EnergySource object when energy stored in the energy source is deplete...
virtual void HandleEnergyRecharged(void)=0
This function is called by the EnergySource object when energy stored in the energy source is recharg...
static TypeId GetTypeId(void)
Get the type ID.
double GetCurrentA(void) const
A base class which provides memory management and object aggregation.
Definition: object.h:88
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:74
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.