Topology file reader (Rocketfuel-format type). More...

#include "rocketfuel-topology-reader.h"

Inheritance diagram for ns3::RocketfuelTopologyReader:

Collaboration diagram for ns3::RocketfuelTopologyReader:

Public Member Functions
	RocketfuelTopologyReader ()

	RocketfuelTopologyReader (const RocketfuelTopologyReader &)=delete

	~RocketfuelTopologyReader () override

RocketfuelTopologyReader &	operator= (const RocketfuelTopologyReader &)=delete

NodeContainer	Read () override
	Main topology reading function.

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

	TopologyReader (const TopologyReader &)=delete

	~TopologyReader () override

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

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

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

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

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

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

TopologyReader &	operator= (const TopologyReader &)=delete

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

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

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

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

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

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

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

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

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

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

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

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

Private Types
enum	RF_FileType { RF_MAPS , RF_WEIGHTS , RF_UNKNOWN }
	Enum of the possible file types. More...

Private Member Functions
NodeContainer	GenerateFromMapsFile (const std::vector< std::string > &argv)
	Topology read function from a file containing the nodes map.

NodeContainer	GenerateFromWeightsFile (const std::vector< std::string > &argv)
	Topology read function from a file containing the nodes weights.

RF_FileType	GetFileType (const std::string &buf)
	Classifies the file type according to its content.

Private Attributes
int	m_linksNumber
	Number of links.

std::map< std::string, Ptr< Node > >	m_nodeMap
	Map of the nodes (name, node).

int	m_nodesNumber
	Number of nodes.

Additional Inherited Members
Public Types inherited from ns3::TopologyReader
typedef std::list< Link >::const_iterator	ConstLinksIterator
	Constant iterator to the list of the links.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Topology file reader (Rocketfuel-format type).

Introspection did not find any typical Config paths.

http://www.cs.washington.edu/research/networking/rocketfuel/

May 2nd, 2010: Currently only support "weights" file and "cch" file. http://www.cs.washington.edu/research/networking/rocketfuel/maps/weights-dist.tar.gz http://www.cs.washington.edu/research/networking/rocketfuel/maps/rocketfuel_maps_cch.tar.gz

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 112 bytes (on a 64-bit architecture).

Definition at line 47 of file rocketfuel-topology-reader.h.

Member Enumeration Documentation

◆ RF_FileType

enum ns3::RocketfuelTopologyReader::RF_FileType

private

Enum of the possible file types.

Enumerator
RF_MAPS
RF_WEIGHTS
RF_UNKNOWN

Definition at line 101 of file rocketfuel-topology-reader.h.

Constructor & Destructor Documentation

◆ RocketfuelTopologyReader() [1/2]

ns3::RocketfuelTopologyReader::RocketfuelTopologyReader ( )

Definition at line 55 of file rocketfuel-topology-reader.cc.

References m_linksNumber, m_nodesNumber, and NS_LOG_FUNCTION.

◆ ~RocketfuelTopologyReader()

ns3::RocketfuelTopologyReader::~RocketfuelTopologyReader ( )

override

Definition at line 62 of file rocketfuel-topology-reader.cc.

References NS_LOG_FUNCTION.

◆ RocketfuelTopologyReader() [2/2]

ns3::RocketfuelTopologyReader::RocketfuelTopologyReader ( const RocketfuelTopologyReader & )

delete

Member Function Documentation

◆ GenerateFromMapsFile()

NodeContainer ns3::RocketfuelTopologyReader::GenerateFromMapsFile ( const std::vector< std::string > & argv )

private

Topology read function from a file containing the nodes map.

Parser for the *.cch file available at: http://www.cs.washington.edu/research/networking/rocketfuel/maps/rocketfuel_maps_cch.tar.gz

Parameters

[in] argv Argument vector.

Returns: The container of the nodes created (or empty container if there was an error).

Definition at line 127 of file rocketfuel-topology-reader.cc.

References ns3::Names::Add(), ns3::TopologyReader::AddLink(), m_linksNumber, m_nodeMap, m_nodesNumber, nodes, NS_LOG_INFO, NS_LOG_WARN, and ns3::PrintNodeInfo().

Referenced by Read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GenerateFromWeightsFile()

NodeContainer ns3::RocketfuelTopologyReader::GenerateFromWeightsFile ( const std::vector< std::string > & argv )

private

Topology read function from a file containing the nodes weights.

Parser for the weights.* file available at: http://www.cs.washington.edu/research/networking/rocketfuel/maps/weights-dist.tar.gz

Parameters

[in] argv Argument vector.

Returns: The container of the nodes created (or empty container if there was an error).

Definition at line 254 of file rocketfuel-topology-reader.cc.

References ns3::Names::Add(), ns3::TopologyReader::AddLink(), ns3::TopologyReader::LinksBegin(), ns3::TopologyReader::LinksEnd(), m_linksNumber, m_nodeMap, m_nodesNumber, nodes, NS_LOG_INFO, and NS_LOG_WARN.

Referenced by Read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFileType()

RocketfuelTopologyReader::RF_FileType ns3::RocketfuelTopologyReader::GetFileType ( const std::string & buf )

private

Classifies the file type according to its content.

Parameters

buf	the first line of the file being read

Returns: The file type (RF_MAPS, RF_WEIGHTS, or RF_UNKNOWN)

Definition at line 323 of file rocketfuel-topology-reader.cc.

References RF_MAPS, RF_UNKNOWN, RF_WEIGHTS, ns3::rocketfuel_maps_regex(), and ns3::rocketfuel_weights_regex().

Referenced by Read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::RocketfuelTopologyReader::GetTypeId ( )

static

Get the type ID.

Returns: The object TypeId

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

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ operator=()

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

delete

◆ Read()

NodeContainer ns3::RocketfuelTopologyReader::Read ( )

overridevirtual

Main topology reading function.

This method opens an input stream and reads the Rocketfuel-format file. Every row represents a topology link (the ids of a couple of nodes), so the input file is read line by line to figure out how many links and nodes are in the topology.