A Discrete-Event Network Simulator
API
node-container.h
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  *
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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #ifndef NODE_CONTAINER_H
21 #define NODE_CONTAINER_H
22 
23 #include <stdint.h>
24 #include <vector>
25 #include "ns3/node.h"
26 
27 namespace ns3 {
28 
39 {
40 public:
42  typedef std::vector<Ptr<Node> >::const_iterator Iterator;
43 
47  NodeContainer ();
48 
55  NodeContainer (Ptr<Node> node);
56 
64  NodeContainer (std::string nodeName);
65 
81  NodeContainer (const NodeContainer &a, const NodeContainer &b);
82 
99  NodeContainer (const NodeContainer &a, const NodeContainer &b, const NodeContainer &c);
100 
118  NodeContainer (const NodeContainer &a, const NodeContainer &b, const NodeContainer &c, const NodeContainer &d);
119 
138  NodeContainer (const NodeContainer &a, const NodeContainer &b, const NodeContainer &c, const NodeContainer &d,
139  const NodeContainer &e);
140 
160  Iterator Begin (void) const;
161 
181  Iterator End (void) const;
182 
203  uint32_t GetN (void) const;
204 
226  Ptr<Node> Get (uint32_t i) const;
227 
238  void Create (uint32_t n);
239 
252  void Create (uint32_t n, uint32_t systemId);
253 
260  void Add (NodeContainer other);
261 
267  void Add (Ptr<Node> node);
268 
275  void Add (std::string nodeName);
276 
289  static NodeContainer GetGlobal (void);
290 
291 private:
292  std::vector<Ptr<Node> > m_nodes;
293 };
294 
295 } // namespace ns3
296 
297 #endif /* NODE_CONTAINER_H */
std::vector< Ptr< Node > >::const_iterator Iterator
Node container iterator.
std::vector< Ptr< Node > > m_nodes
Nodes smart pointers.
Iterator End(void) const
Get an iterator which indicates past-the-last Node in the container.
uint32_t GetN(void) const
Get the number of Ptr<Node> stored in this container.
NodeContainer()
Create an empty NodeContainer.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
keep track of a set of node pointers.
Iterator Begin(void) const
Get an iterator which refers to the first Node in the container.
static NodeContainer GetGlobal(void)
Create a NodeContainer that contains a list of all nodes created through NodeContainer::Create() and ...
void Add(NodeContainer other)
Append the contents of another NodeContainer to the end of this container.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.