Interface for input file readers management. More...

#include <topology-reader.h>

Inheritance diagram for ns3::TopologyReader:

Collaboration diagram for ns3::TopologyReader:

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. More...

Public Member Functions
	TopologyReader ()

virtual	~TopologyReader ()

void	AddLink (Link link)
	Adds a link to the topology. More...

std::string	GetFileName (void) const
	Returns the input file name. More...

ConstLinksIterator	LinksBegin (void) const
	Returns an iterator to the the first link in this block. More...

bool	LinksEmpty (void) const
	Checks if the block contains any links. More...

ConstLinksIterator	LinksEnd (void) const
	Returns an iterator to the the last link in this block. More...

int	LinksSize (void) const
	Returns the number of links in this block. More...

virtual NodeContainer	Read (void)=0
	Main topology reading function. More...

void	SetFileName (const std::string &fileName)
	Sets the input file name. More...

Public Member Functions inherited from ns3::Object
	Object ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

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)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Member Functions
	TopologyReader (const TopologyReader &)
	Copy constructor. More...

TopologyReader &	operator= (const TopologyReader &)
	Copy constructor. More...

Private Attributes
std::string	m_fileName
	the name of the input file More...

std::list< Link >	m_linksList
	the container of the links between the nodes More...

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

Interface for input file readers management.

Doxygen introspection did not find any typical Config paths.

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

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

Definition at line 43 of file topology-reader.h.

Member Typedef Documentation

typedef std::list< Link >::const_iterator ns3::TopologyReader::ConstLinksIterator

Constant iterator to the list of the links.

Definition at line 136 of file topology-reader.h.

Constructor & Destructor Documentation

ns3::TopologyReader::TopologyReader ( )

Definition at line 43 of file topology-reader.cc.

References NS_LOG_FUNCTION.

ns3::TopologyReader::~TopologyReader ( )

virtual

Definition at line 48 of file topology-reader.cc.

References NS_LOG_FUNCTION.

ns3::TopologyReader::TopologyReader ( const TopologyReader & )

private

Copy constructor.

Defined and unimplemented to avoid misuse

Member Function Documentation

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

Adds a link to the topology.

Parameters

link	the link to be added.

Definition at line 92 of file topology-reader.cc.

References m_linksList.

Referenced by ns3::RocketfuelTopologyReader::GenerateFromMapsFile(), ns3::RocketfuelTopologyReader::GenerateFromWeightsFile(), ns3::OrbisTopologyReader::Read(), and ns3::InetTopologyReader::Read().

Here is the caller graph for this function:

std::string ns3::TopologyReader::GetFileName ( void ) const

Returns the input file name.

Returns: the input file name.

Definition at line 60 of file topology-reader.cc.

References m_fileName.

Referenced by ns3::RocketfuelTopologyReader::Read(), ns3::OrbisTopologyReader::Read(), and ns3::InetTopologyReader::Read().

Here is the caller graph for this function:

TypeId ns3::TopologyReader::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 35 of file topology-reader.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

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.

Definition at line 68 of file topology-reader.cc.

References m_linksList.

Referenced by ns3::RocketfuelTopologyReader::GenerateFromWeightsFile(), and main().

Here is the caller graph for this function:

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.

Definition at line 86 of file topology-reader.cc.

References m_linksList.

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.

Definition at line 74 of file topology-reader.cc.

References m_linksList.

Referenced by ns3::RocketfuelTopologyReader::GenerateFromWeightsFile(), and main().

Here is the caller graph for this function:

int ns3::TopologyReader::LinksSize ( void ) const

Returns the number of links in this block.

Returns: the number of links in this block.

Definition at line 80 of file topology-reader.cc.

References m_linksList.

Referenced by main().

Here is the caller graph for this function:

TopologyReader& ns3::TopologyReader::operator= ( const TopologyReader & )

private

Copy constructor.

Defined and unimplemented to avoid misuse

Returns

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.

Referenced by main().

Here is the caller graph for this function:

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

Sets the input file name.

Parameters

fileName the input file name.

Definition at line 54 of file topology-reader.cc.

References m_fileName.

Member Data Documentation

std::string ns3::TopologyReader::m_fileName

private

the name of the input file

Definition at line 221 of file topology-reader.h.

Referenced by GetFileName(), and SetFileName().

std::list<Link> ns3::TopologyReader::m_linksList

private

the container of the links between the nodes

Definition at line 226 of file topology-reader.h.

Referenced by AddLink(), LinksBegin(), LinksEmpty(), LinksEnd(), and LinksSize().

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

src/topology-read/model/topology-reader.h
src/topology-read/model/topology-reader.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation