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.
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.
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::TopologyReader.

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:

link

the link to be added.

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

Returns the input file name.

Returns:: the input file name.

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

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

This object is accessible through the following paths with Config::Set and Config::Connect:

/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::TopologyReader
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::TopologyReader
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::TopologyReader
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::TopologyReader
/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::TopologyReader
/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::TopologyReader
/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::TopologyReader
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::TopologyReader
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::TopologyReader
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::TopologyReader
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::TopologyReader
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::TopologyReader
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::TopologyReader
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::TopologyReader
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::TopologyReader
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::TopologyReader
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::TopologyReader

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

Reimplemented from ns3::Object.

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

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.

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, and ns3::OrbisTopologyReader.

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

Sets the input file name.

Parameters:

fileName

the input file name.

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

src/contrib/topology-read/topology-reader.h
doc/introspected-doxygen.h

ns3::TopologyReader Class Reference [Topology Input Readers]

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

ns3::TopologyReader Class Reference
[Topology Input Readers]