A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 
24 #include "ns3/names.h"
25 
26 namespace ns3 {
27 
28 TypeId
30 {
31  static TypeId tid = TypeId ("ns3::EnergySourceContainer")
32  .SetParent<Object> ()
33  .AddConstructor<EnergySourceContainer> ()
34  ;
35  return tid;
36 }
37 
39 {
40 }
41 
43 {
44 }
45 
47 {
48  NS_ASSERT (source != NULL);
49  m_sources.push_back (source);
50 }
51 
53 {
54  Ptr<EnergySource> source = Names::Find<EnergySource> (sourceName);
55  NS_ASSERT (source != NULL);
56  m_sources.push_back (source);
57 }
58 
60  const EnergySourceContainer &b)
61 {
62  *this = a;
63  Add (b);
64 }
65 
68 {
69  return m_sources.begin ();
70 }
71 
74 {
75  return m_sources.end ();
76 }
77 
78 uint32_t
80 {
81  return m_sources.size ();
82 }
83 
85 EnergySourceContainer::Get (uint32_t i) const
86 {
87  return m_sources[i];
88 }
89 
90 void
92 {
93  for (Iterator i = container.Begin (); i != container.End (); i++)
94  {
95  m_sources.push_back (*i);
96  }
97 }
98 
99 void
101 {
102  NS_ASSERT (source != NULL);
103  m_sources.push_back (source);
104 }
105 
106 void
107 EnergySourceContainer::Add (std::string sourceName)
108 {
109  Ptr<EnergySource> source = Names::Find<EnergySource> (sourceName);
110  NS_ASSERT (source != NULL);
111  m_sources.push_back (source);
112 }
113 
114 /*
115  * Private functions start here.
116  */
117 
118 void
120 {
121  // call Object::Dispose for all EnergySource objects
122  for (std::vector< Ptr<EnergySource> >::iterator i = m_sources.begin ();
123  i != m_sources.end (); i++)
124  {
125  (*i)->DisposeDeviceModels ();
126  (*i)->Dispose ();
127  }
128  m_sources.clear ();
129 }
130 
131 void
133 {
134  // call Object::Start for all EnergySource objects
135  for (std::vector< Ptr<EnergySource> >::iterator i = m_sources.begin ();
136  i != m_sources.end (); i++)
137  {
138  (*i)->Initialize ();
139  (*i)->InitializeDeviceModels ();
140  }
141 }
142 
143 } // namespace ns3
smart pointer class similar to boost::intrusive_ptr
Definition: ptr.h:60
Holds a vector of ns3::EnergySource pointers.
void Add(EnergySourceContainer container)
uint32_t GetN(void) const
Get the number of Ptr stored in this container.
std::vector< Ptr< EnergySource > >::const_iterator Iterator
#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
std::vector< Ptr< EnergySource > > m_sources
virtual void DoDispose(void)
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
Iterator End(void) const
Get an iterator which refers to the last EnergySource pointer in the container.
Ptr< EnergySource > Get(uint32_t i) const
Get the i-th Ptr stored in this container.
a base class which provides memory management and object aggregation
Definition: object.h:64
EnergySourceContainer()
Creates an empty EnergySourceContainer.
Iterator Begin(void) const
Get an iterator which refers to the first EnergySource pointer in the container.
a unique identifier for an interface.
Definition: type-id.h:49
TypeId SetParent(TypeId tid)
Definition: type-id.cc:610
virtual void DoInitialize(void)
Calls Object::Start () for all EnergySource objects.