A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
energy-harvester.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2014 Wireless Communications and Networking Group (WCNG),
3
* University of Rochester, Rochester, NY, USA.
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: Cristiano Tapparello <cristiano.tapparello@rochester.edu>
19
*/
20
21
#ifndef ENERGY_HARVESTER_H
22
#define ENERGY_HARVESTER_H
23
24
#include <iostream>
25
26
// include from ns-3
27
#include "ns3/energy-source-container.h"
28
#include "ns3/node.h"
29
#include "ns3/object.h"
30
#include "ns3/ptr.h"
31
#include "ns3/type-id.h"
32
33
namespace
ns3
34
{
35
36
class
EnergySource;
37
44
class
EnergyHarvester
:
public
Object
45
{
46
public
:
51
static
TypeId
GetTypeId
();
52
53
EnergyHarvester
();
54
55
~EnergyHarvester
()
override
;
56
62
void
SetNode
(
Ptr<Node>
node);
63
70
Ptr<Node>
GetNode
()
const
;
71
79
void
SetEnergySource
(
Ptr<EnergySource>
source);
80
87
Ptr<EnergySource>
GetEnergySource
()
const
;
88
95
double
GetPower
()
const
;
96
97
private
:
102
void
DoDispose
()
override
;
103
114
virtual
double
DoGetPower
()
const
;
115
116
private
:
121
Ptr<Node>
m_node
;
122
128
Ptr<EnergySource>
m_energySource
;
129
130
protected
:
131
};
132
133
}
// namespace ns3
134
135
#endif
/* defined(ENERGY_HARVESTER_H) */
ns3::EnergyHarvester
Energy harvester base class.
Definition:
energy-harvester.h:45
ns3::EnergyHarvester::GetEnergySource
Ptr< EnergySource > GetEnergySource() const
Definition:
energy-harvester.cc:73
ns3::EnergyHarvester::GetNode
Ptr< Node > GetNode() const
Definition:
energy-harvester.cc:58
ns3::EnergyHarvester::m_energySource
Ptr< EnergySource > m_energySource
Pointer to the Energy Source to which this EnergyHarvester is connected.
Definition:
energy-harvester.h:128
ns3::EnergyHarvester::GetPower
double GetPower() const
Definition:
energy-harvester.cc:80
ns3::EnergyHarvester::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
energy-harvester.cc:33
ns3::EnergyHarvester::DoGetPower
virtual double DoGetPower() const
This method is called by the GetPower method and it needs to be implemented by the subclasses of the ...
Definition:
energy-harvester.cc:97
ns3::EnergyHarvester::m_node
Ptr< Node > m_node
Pointer to node containing this EnergyHarvester.
Definition:
energy-harvester.h:121
ns3::EnergyHarvester::~EnergyHarvester
~EnergyHarvester() override
Definition:
energy-harvester.cc:44
ns3::EnergyHarvester::DoDispose
void DoDispose() override
Defined in ns3::Object.
Definition:
energy-harvester.cc:91
ns3::EnergyHarvester::EnergyHarvester
EnergyHarvester()
Definition:
energy-harvester.cc:39
ns3::EnergyHarvester::SetNode
void SetNode(Ptr< Node > node)
Sets pointer to node containing this EnergyHarvester.
Definition:
energy-harvester.cc:50
ns3::EnergyHarvester::SetEnergySource
void SetEnergySource(Ptr< EnergySource > source)
Definition:
energy-harvester.cc:65
ns3::Object
A base class which provides memory management and object aggregation.
Definition:
object.h:89
ns3::Ptr< Node >
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:59
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
energy
model
energy-harvester.h
Generated on Sun Mar 3 2024 17:10:57 for ns-3 by
1.9.1