ns-3
ns3::TopologyReader Class Reference

Interface for input file readers management. More...

#include <topology-reader.h>

Inheritance diagram for ns3::TopologyReader:
Collaboration diagram for ns3::TopologyReader:

List of all members.

Classes

class  Link
 Inner class holding the details about a link between two nodes. More...

Public Types

typedef std::list< Link >
::const_iterator 
ConstLinksIterator
 Constant iterator to the list of the links.

Public Member Functions

virtual NodeContainer Read (void)=0
 Main topology reading function.
void SetFileName (const std::string &fileName)
 Sets the input file name.
std::string GetFileName (void) const
 Returns the input file name.
ConstLinksIterator LinksBegin (void) const
 Returns an iterator to the the first link in this block.
ConstLinksIterator LinksEnd (void) const
 Returns an iterator to the the last link in this block.
int LinksSize (void) const
 Returns the number of links in this block.
bool LinksEmpty (void) const
 Checks if the block contains any links.
void AddLink (Link link)
 Adds a link to the topology.
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::TopologyReader.

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
virtual void NotifyNewAggregate (void)
virtual void DoStart (void)
virtual void DoDispose (void)
 Object (const Object &o)

Detailed Description

Interface for input file readers management.

This interface perform the shared tasks among all possible input file readers. Each different file format is handled by its own topology reader.


Member Function Documentation

void ns3::TopologyReader::AddLink ( Link  link)

Adds a link to the topology.

Parameters:
linkthe link to be added.
std::string ns3::TopologyReader::GetFileName ( void  ) const

Returns the input file name.

Returns:
the input file name.

Referenced by ns3::RocketfuelTopologyReader::Read().

TypeId ns3::TopologyReader::GetTypeId ( void  )
static

This method returns the TypeId associated to ns3::TopologyReader.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Object.

Reimplemented in ns3::InetTopologyReader, ns3::OrbisTopologyReader, and ns3::RocketfuelTopologyReader.

References ns3::TypeId::SetParent().

TopologyReader::ConstLinksIterator ns3::TopologyReader::LinksBegin ( void  ) const

Returns an iterator to the the first link in this block.

Returns:
a const iterator to the first link in this block.
bool ns3::TopologyReader::LinksEmpty ( void  ) const

Checks if the block contains any links.

Returns:
true if there are no links in this block, false otherwise.
TopologyReader::ConstLinksIterator ns3::TopologyReader::LinksEnd ( void  ) const

Returns an iterator to the the last link in this block.

Returns:
a const iterator to the last link in this block.
int ns3::TopologyReader::LinksSize ( void  ) const

Returns the number of links in this block.

Returns:
the number of links in this block.
virtual NodeContainer ns3::TopologyReader::Read ( void  )
pure virtual

Main topology reading function.

The data is parsed and the results are returned in the passed lists. The rationale behind this choice is to allow non-progressive node IDs in the topology files, as well as to separate the topology reader from the choices about actual IP number assignment and kind of links between nodes.

Returns:
the container of the nodes created (or null if there was an error)

Implemented in ns3::InetTopologyReader, ns3::OrbisTopologyReader, and ns3::RocketfuelTopologyReader.

void ns3::TopologyReader::SetFileName ( const std::string &  fileName)

Sets the input file name.

Parameters:
fileNamethe input file name.

Referenced by ns3::TopologyReaderHelper::GetTopologyReader().


The documentation for this class was generated from the following files: