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)

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)

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

	SimpleRefCount (const SimpleRefCount &o)

uint32_t	GetReferenceCount (void) const

SimpleRefCount &	operator= (const SimpleRefCount &o)

void	Ref (void) const

void	Unref (void) const

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()

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)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)

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

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Private Member Functions
	TopologyReader (const TopologyReader &)

TopologyReader &	operator= (const TopologyReader &)

Private Attributes
std::string	m_fileName

std::list< Link >	m_linksList

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

virtual void	DoDispose (void)

virtual void	DoInitialize (void)

virtual void	NotifyNewAggregate (void)

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

virtual void	NotifyConstructionCompleted (void)

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.

Doxygen introspection did not find any typical Config paths.
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 41 of file topology-reader.cc.

References NS_LOG_FUNCTION.

ns3::TopologyReader::~TopologyReader ( )

virtual

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

References NS_LOG_FUNCTION.

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

private

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 90 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 58 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

Definition at line 33 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 66 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 84 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 72 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 78 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

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 52 of file topology-reader.cc.

References m_fileName.

Member Data Documentation

std::string ns3::TopologyReader::m_fileName

private

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

Referenced by GetFileName(), and SetFileName().

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

private

Definition at line 203 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