A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
topology-reader.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2010 Universita' di Firenze, Italy
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: Tommaso Pecorella (tommaso.pecorella@unifi.it)
19  * Author: Valerio Sartini (valesar@gmail.com)
20  */
21 
22 #ifndef TOPOLOGY_READER_H
23 #define TOPOLOGY_READER_H
24 
25 #include <string>
26 #include <map>
27 #include <list>
28 
29 #include "ns3/object.h"
30 #include "ns3/node-container.h"
31 
32 
33 namespace ns3 {
34 
43 class TopologyReader : public Object
44 {
45 
46 public:
54  class Link
55  {
56 public:
60  typedef std::map<std::string, std::string>::const_iterator ConstAttributesIterator;
61 
69  Link ( Ptr<Node> fromPtr, const std::string &fromName, Ptr<Node> toPtr, const std::string &toName );
70 
75  Ptr<Node> GetFromNode (void) const;
80  std::string GetFromNodeName (void) const;
85  Ptr<Node> GetToNode (void) const;
90  std::string GetToNodeName (void) const;
98  std::string GetAttribute (const std::string &name) const;
106  bool GetAttributeFailSafe (const std::string &name, std::string &value) const;
112  void SetAttribute (const std::string &name, const std::string &value);
123 
124 private:
125  Link ();
126  std::string m_fromName;
128  std::string m_toName;
130  std::map<std::string, std::string> m_linkAttr;
131  };
132 
136  typedef std::list< Link >::const_iterator ConstLinksIterator;
137 
142  static TypeId GetTypeId (void);
143 
144  TopologyReader ();
145  virtual ~TopologyReader ();
146 
158  virtual NodeContainer Read (void) = 0;
159 
164  void SetFileName (const std::string &fileName);
165 
170  std::string GetFileName (void) const;
171 
176  ConstLinksIterator LinksBegin (void) const;
177 
182  ConstLinksIterator LinksEnd (void) const;
183 
188  int LinksSize (void) const;
189 
194  bool LinksEmpty (void) const;
195 
200  void AddLink (Link link);
201 
202 private:
203 
217 
221  std::string m_fileName;
222 
226  std::list<Link> m_linksList;
227 
228  // end class TopologyReader
229 };
230 
231 // end namespace ns3
232 };
233 
234 
235 #endif /* TOPOLOGY_READER_H */
static TypeId GetTypeId(void)
Get the type ID.
ConstLinksIterator LinksBegin(void) const
Returns an iterator to the the first link in this block.
std::string GetFileName(void) const
Returns the input file name.
std::list< Link > m_linksList
the container of the links between the nodes
TopologyReader & operator=(const TopologyReader &)
Copy constructor.
bool LinksEmpty(void) const
Checks if the block contains any links.
void AddLink(Link link)
Adds a link to the topology.
Interface for input file readers management.
int LinksSize(void) const
Returns the number of links in this block.
void SetFileName(const std::string &fileName)
Sets the input file name.
std::list< Link >::const_iterator ConstLinksIterator
Constant iterator to the list of the links.
keep track of a set of node pointers.
std::string m_fileName
the name of the input file
virtual NodeContainer Read(void)=0
Main topology reading function.
a base class which provides memory management and object aggregation
Definition: object.h:63
a unique identifier for an interface.
Definition: type-id.h:49
ConstLinksIterator LinksEnd(void) const
Returns an iterator to the the last link in this block.