A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Portuguese
Docs ▼
Wiki
Manual
Models
Develop ▼
API
Bugs
API
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Properties
Friends
Macros
Groups
Pages
energy-harvester.cc
Go to the documentation of this file.
1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2
/*
3
* Copyright (c) 2014 Wireless Communications and Networking Group (WCNG),
4
* University of Rochester, Rochester, NY, USA.
5
*
6
* This program is free software; you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License version 2 as
8
* published by the Free Software Foundation;
9
*
10
* This program is distributed in the hope that it will be useful,
11
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
* GNU General Public License for more details.
14
*
15
* You should have received a copy of the GNU General Public License
16
* along with this program; if not, write to the Free Software
17
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
*
19
* Author: Cristiano Tapparello <cristiano.tapparello@rochester.edu>
20
*/
21
22
#include "
energy-harvester.h
"
23
#include "ns3/log.h"
24
25
NS_LOG_COMPONENT_DEFINE
(
"EnergyHarvester"
);
26
27
namespace
ns3 {
28
29
NS_OBJECT_ENSURE_REGISTERED
(EnergyHarvester);
30
31
TypeId
32
EnergyHarvester::GetTypeId
(
void
)
33
{
34
static
TypeId
tid =
TypeId
(
"ns3::EnergyHarvester"
)
35
.
SetParent
<
Object
> ()
36
;
37
return
tid;
38
}
39
40
EnergyHarvester::EnergyHarvester
()
41
{
42
NS_LOG_FUNCTION
(
this
);
43
}
44
45
EnergyHarvester::~EnergyHarvester
()
46
{
47
NS_LOG_FUNCTION
(
this
);
48
}
49
50
void
51
EnergyHarvester::SetNode
(
Ptr<Node>
node)
52
{
53
NS_LOG_FUNCTION
(
this
);
54
NS_ASSERT
(node != 0);
55
m_node
= node;
56
}
57
58
Ptr<Node>
59
EnergyHarvester::GetNode
(
void
)
const
60
{
61
NS_LOG_FUNCTION
(
this
);
62
return
m_node
;
63
}
64
65
void
66
EnergyHarvester::SetEnergySource
(
Ptr<EnergySource>
source)
67
{
68
NS_LOG_FUNCTION
(
this
);
69
NS_ASSERT
(source != 0);
70
m_energySource
= source;
71
}
72
73
Ptr<EnergySource>
74
EnergyHarvester::GetEnergySource
(
void
)
const
75
{
76
NS_LOG_FUNCTION
(
this
);
77
return
m_energySource
;
78
}
79
80
81
double
82
EnergyHarvester::GetPower
(
void
)
const
83
{
84
NS_LOG_FUNCTION
(
this
);
85
return
DoGetPower
();
86
}
87
88
/*
89
* Private function starts here.
90
*/
91
92
void
93
EnergyHarvester::DoDispose
(
void
)
94
{
95
NS_LOG_FUNCTION
(
this
);
96
}
97
98
double
99
EnergyHarvester::DoGetPower
(
void
)
const
100
{
101
NS_LOG_FUNCTION
(
this
);
102
return
0.0;
103
}
104
105
}
ns3::Ptr< Node >
NS_LOG_FUNCTION
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
Definition:
log-macros-enabled.h:207
ns3::EnergyHarvester::GetEnergySource
Ptr< EnergySource > GetEnergySource(void) const
Definition:
energy-harvester.cc:74
NS_OBJECT_ENSURE_REGISTERED
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register the class in the ns-3 factory.
Definition:
object-base.h:38
ns3::EnergyHarvester::m_node
Ptr< Node > m_node
Pointer to node containing this EnergyHarvester.
Definition:
energy-harvester.h:122
NS_ASSERT
#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
NS_LOG_COMPONENT_DEFINE
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition:
log.h:170
ns3::EnergyHarvester::SetEnergySource
void SetEnergySource(Ptr< EnergySource > source)
Definition:
energy-harvester.cc:66
ns3::EnergyHarvester::GetPower
double GetPower(void) const
Definition:
energy-harvester.cc:82
ns3::EnergyHarvester::GetTypeId
static TypeId GetTypeId(void)
Definition:
energy-harvester.cc:32
energy-harvester.h
ns3::EnergyHarvester::~EnergyHarvester
virtual ~EnergyHarvester()
Definition:
energy-harvester.cc:45
ns3::EnergyHarvester::DoDispose
virtual void DoDispose(void)
Defined in ns3::Object.
Definition:
energy-harvester.cc:93
ns3::EnergyHarvester::DoGetPower
virtual double DoGetPower(void) const
This method is called by the GetPower method and it needs to be implemented by the subclasses of the ...
Definition:
energy-harvester.cc:99
ns3::EnergyHarvester::EnergyHarvester
EnergyHarvester()
Definition:
energy-harvester.cc:40
ns3::EnergyHarvester::m_energySource
Ptr< EnergySource > m_energySource
Pointer to the Energy Source to which this EnergyHarvester is connected.
Definition:
energy-harvester.h:129
ns3::Object
a base class which provides memory management and object aggregation
Definition:
object.h:64
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:49
ns3::EnergyHarvester::SetNode
void SetNode(Ptr< Node > node)
Sets pointer to node containing this EnergyHarvester.
Definition:
energy-harvester.cc:51
ns3::EnergyHarvester::GetNode
Ptr< Node > GetNode(void) const
Definition:
energy-harvester.cc:59
ns3::TypeId::SetParent
TypeId SetParent(TypeId tid)
Definition:
type-id.cc:610
src
energy
model
energy-harvester.cc
Generated on Wed Sep 17 2014 23:33:25 for ns-3 by
1.8.6