A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Portuguese
Docs ▼
Wiki
Manual
Models
Develop ▼
API
Bugs
API
src
energy
helper
energy-source-container.cc
Go to the documentation of this file.
1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2
/*
3
* Copyright (c) 2008 INRIA
4
* Copyright (c) 2010 Network Security Lab, University of Washington, Seattle.
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
* Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
20
* Sidharth Nabar <snabar@uw.edu>, He Wu <mdzz@u.washington.edu>
21
*/
22
23
#include "
energy-source-container.h
"
24
#include "ns3/names.h"
25
26
namespace
ns3
{
27
28
NS_OBJECT_ENSURE_REGISTERED
(EnergySourceContainer);
29
30
TypeId
31
EnergySourceContainer::GetTypeId
(
void
)
32
{
33
static
TypeId
tid =
TypeId
(
"ns3::EnergySourceContainer"
)
34
.
SetParent
<
Object
> ()
35
.SetGroupName (
"Energy"
)
36
.AddConstructor<
EnergySourceContainer
> ()
37
;
38
return
tid;
39
}
40
41
EnergySourceContainer::EnergySourceContainer
()
42
{
43
}
44
45
EnergySourceContainer::~EnergySourceContainer
()
46
{
47
}
48
49
EnergySourceContainer::EnergySourceContainer
(
Ptr<EnergySource>
source)
50
{
51
NS_ASSERT
(source != NULL);
52
m_sources
.push_back (source);
53
}
54
55
EnergySourceContainer::EnergySourceContainer
(std::string sourceName)
56
{
57
Ptr<EnergySource>
source = Names::Find<EnergySource> (sourceName);
58
NS_ASSERT
(source != NULL);
59
m_sources
.push_back (source);
60
}
61
62
EnergySourceContainer::EnergySourceContainer
(
const
EnergySourceContainer
&a,
63
const
EnergySourceContainer
&b)
64
{
65
*
this
= a;
66
Add
(b);
67
}
68
69
EnergySourceContainer::Iterator
70
EnergySourceContainer::Begin
(
void
)
const
71
{
72
return
m_sources
.begin ();
73
}
74
75
EnergySourceContainer::Iterator
76
EnergySourceContainer::End
(
void
)
const
77
{
78
return
m_sources
.end ();
79
}
80
81
uint32_t
82
EnergySourceContainer::GetN
(
void
)
const
83
{
84
return
m_sources
.size ();
85
}
86
87
Ptr<EnergySource>
88
EnergySourceContainer::Get
(uint32_t i)
const
89
{
90
return
m_sources
[i];
91
}
92
93
void
94
EnergySourceContainer::Add
(
EnergySourceContainer
container)
95
{
96
for
(
Iterator
i = container.
Begin
(); i != container.
End
(); i++)
97
{
98
m_sources
.push_back (*i);
99
}
100
}
101
102
void
103
EnergySourceContainer::Add
(
Ptr<EnergySource>
source)
104
{
105
NS_ASSERT
(source != NULL);
106
m_sources
.push_back (source);
107
}
108
109
void
110
EnergySourceContainer::Add
(std::string sourceName)
111
{
112
Ptr<EnergySource>
source = Names::Find<EnergySource> (sourceName);
113
NS_ASSERT
(source != NULL);
114
m_sources
.push_back (source);
115
}
116
117
/*
118
* Private functions start here.
119
*/
120
121
void
122
EnergySourceContainer::DoDispose
(
void
)
123
{
124
// call Object::Dispose for all EnergySource objects
125
for
(std::vector<
Ptr<EnergySource>
>::iterator i =
m_sources
.begin ();
126
i !=
m_sources
.end (); i++)
127
{
128
(*i)->DisposeDeviceModels ();
129
(*i)->Dispose ();
130
}
131
m_sources
.clear ();
132
}
133
134
void
135
EnergySourceContainer::DoInitialize
(
void
)
136
{
137
// call Object::Start for all EnergySource objects
138
for
(std::vector<
Ptr<EnergySource>
>::iterator i =
m_sources
.begin ();
139
i !=
m_sources
.end (); i++)
140
{
141
(*i)->Initialize ();
142
(*i)->InitializeDeviceModels ();
143
}
144
}
145
146
}
// namespace ns3
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition:
ptr.h:73
ns3::EnergySourceContainer
Holds a vector of ns3::EnergySource pointers.
Definition:
energy-source-container.h:44
ns3::EnergySourceContainer::Add
void Add(EnergySourceContainer container)
Definition:
energy-source-container.cc:94
ns3::EnergySourceContainer::GetTypeId
static TypeId GetTypeId(void)
Definition:
energy-source-container.cc:31
ns3::EnergySourceContainer::End
Iterator End(void) const
Get an iterator which refers to the last EnergySource pointer in the container.
Definition:
energy-source-container.cc:76
NS_OBJECT_ENSURE_REGISTERED
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition:
object-base.h:45
ns3::EnergySourceContainer::Iterator
std::vector< Ptr< EnergySource > >::const_iterator Iterator
Definition:
energy-source-container.h:47
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:67
ns3::EnergySourceContainer::m_sources
std::vector< Ptr< EnergySource > > m_sources
Definition:
energy-source-container.h:176
energy-source-container.h
ns3::EnergySourceContainer::GetN
uint32_t GetN(void) const
Get the number of Ptr<EnergySource> stored in this container.
Definition:
energy-source-container.cc:82
ns3::EnergySourceContainer::DoDispose
virtual void DoDispose(void)
Destructor implementation.
Definition:
energy-source-container.cc:122
ns3::EnergySourceContainer::Begin
Iterator Begin(void) const
Get an iterator which refers to the first EnergySource pointer in the container.
Definition:
energy-source-container.cc:70
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::EnergySourceContainer::~EnergySourceContainer
~EnergySourceContainer()
Definition:
energy-source-container.cc:45
ns3::EnergySourceContainer::Get
Ptr< EnergySource > Get(uint32_t i) const
Get the i-th Ptr<EnergySource> stored in this container.
Definition:
energy-source-container.cc:88
ns3::Object
A base class which provides memory management and object aggregation.
Definition:
object.h:87
ns3::EnergySourceContainer::EnergySourceContainer
EnergySourceContainer()
Creates an empty EnergySourceContainer.
Definition:
energy-source-container.cc:41
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:58
ns3::TypeId::SetParent
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition:
type-id.cc:915
ns3::EnergySourceContainer::DoInitialize
virtual void DoInitialize(void)
Calls Object::Start () for all EnergySource objects.
Definition:
energy-source-container.cc:135
Generated on Wed Nov 7 2018 10:01:52 for ns-3 by
1.8.14