A Discrete-Event Network Simulator
API
energy-source-container.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2008 INRIA
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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  * Sidharth Nabar <snabar@uw.edu>, He Wu <mdzz@u.washington.edu>
20  */
21 
23 
24 #include "ns3/names.h"
25 
26 namespace ns3
27 {
28 
29 NS_OBJECT_ENSURE_REGISTERED(EnergySourceContainer);
30 
31 TypeId
33 {
34  static TypeId tid = TypeId("ns3::EnergySourceContainer")
35  .SetParent<Object>()
36  .SetGroupName("Energy")
37  .AddConstructor<EnergySourceContainer>();
38  return tid;
39 }
40 
42 {
43 }
44 
46 {
47 }
48 
50 {
51  NS_ASSERT(source);
52  m_sources.push_back(source);
53 }
54 
56 {
57  Ptr<EnergySource> source = Names::Find<EnergySource>(sourceName);
58  NS_ASSERT(source);
59  m_sources.push_back(source);
60 }
61 
63  const EnergySourceContainer& b)
64 {
65  *this = a;
66  Add(b);
67 }
68 
71 {
72  return m_sources.begin();
73 }
74 
77 {
78  return m_sources.end();
79 }
80 
81 uint32_t
83 {
84  return m_sources.size();
85 }
86 
88 EnergySourceContainer::Get(uint32_t i) const
89 {
90  return m_sources[i];
91 }
92 
93 void
95 {
96  for (auto i = container.Begin(); i != container.End(); i++)
97  {
98  m_sources.push_back(*i);
99  }
100 }
101 
102 void
104 {
105  NS_ASSERT(source);
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);
114  m_sources.push_back(source);
115 }
116 
117 /*
118  * Private functions start here.
119  */
120 
121 void
123 {
124  // call Object::Dispose for all EnergySource objects
125  for (auto i = m_sources.begin(); i != m_sources.end(); i++)
126  {
127  (*i)->DisposeDeviceModels();
128  (*i)->Dispose();
129  }
130  m_sources.clear();
131 }
132 
133 void
135 {
136  // call Object::Start for all EnergySource objects
137  for (auto i = m_sources.begin(); i != m_sources.end(); i++)
138  {
139  (*i)->Initialize();
140  (*i)->InitializeDeviceModels();
141  }
142 }
143 
144 } // namespace ns3
Holds a vector of ns3::EnergySource pointers.
Ptr< EnergySource > Get(uint32_t i) const
Get the i-th Ptr<EnergySource> stored in this container.
uint32_t GetN() const
Get the number of Ptr<EnergySource> stored in this container.
EnergySourceContainer()
Creates an empty EnergySourceContainer.
Iterator Begin() const
Get an iterator which refers to the first EnergySource pointer in the container.
void Add(EnergySourceContainer container)
void DoInitialize() override
Calls Object::Start () for all EnergySource objects.
std::vector< Ptr< EnergySource > >::const_iterator Iterator
Const iterator for EnergySource container.
static TypeId GetTypeId()
Get the type ID.
std::vector< Ptr< EnergySource > > m_sources
Energy source container.
void DoDispose() override
Destructor implementation.
Iterator End() const
Get an iterator which refers to the last EnergySource pointer in the container.
A base class which provides memory management and object aggregation.
Definition: object.h:89
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:931
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
Definition: assert.h:66
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:46
Every class exported by the ns3 library is enclosed in the ns3 namespace.