A Discrete-Event Network Simulator
API
ns3::RocketfuelTopologyReader Class Reference

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 ()
 
virtual ~RocketfuelTopologyReader ()
 
virtual NodeContainer Read (void)
 Main topology reading function. More...
 
- Public Member Functions inherited from ns3::TopologyReader
 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...
 
void SetFileName (const std::string &fileName)
 Sets the input file name. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. 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
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::TopologyReader
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::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Types

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

Private Member Functions

 RocketfuelTopologyReader (const RocketfuelTopologyReader &)
 Copy constructor. More...
 
NodeContainer GenerateFromMapsFile (int argc, char *argv[])
 Topology read function from a file containing the nodes map. More...
 
NodeContainer GenerateFromWeightsFile (int argc, char *argv[])
 Topology read function from a file containing the nodes weights. More...
 
enum RF_FileType GetFileType (const char *)
 Classifies the file type according to its content. More...
 
RocketfuelTopologyReaderoperator= (const RocketfuelTopologyReader &)
 Copy constructor. More...
 

Private Attributes

int m_linksNumber
 Number of links. More...
 
std::map< std::string, Ptr< Node > > m_nodeMap
 Map of the nodes (name, node). More...
 
int m_nodesNumber
 Number of nodes. More...
 

Additional Inherited Members

- Public Types inherited from ns3::TopologyReader
typedef std::list< Link >::const_iterator ConstLinksIterator
 Constant iterator to the list of the links. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

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 48 of file rocketfuel-topology-reader.h.

Member Enumeration Documentation

◆ RF_FileType

Enum of the possible file types.

Enumerator
RF_MAPS 
RF_WEIGHTS 
RF_UNKNOWN 

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

Constructor & Destructor Documentation

◆ RocketfuelTopologyReader() [1/2]

ns3::RocketfuelTopologyReader::RocketfuelTopologyReader ( )

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

References m_linksNumber, m_nodesNumber, and NS_LOG_FUNCTION.

◆ ~RocketfuelTopologyReader()

ns3::RocketfuelTopologyReader::~RocketfuelTopologyReader ( )
virtual

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

References NS_LOG_FUNCTION.

◆ RocketfuelTopologyReader() [2/2]

ns3::RocketfuelTopologyReader::RocketfuelTopologyReader ( const RocketfuelTopologyReader )
private

Copy constructor.

Defined and unimplemented to avoid misuse.

Member Function Documentation

◆ GenerateFromMapsFile()

NodeContainer ns3::RocketfuelTopologyReader::GenerateFromMapsFile ( int  argc,
char *  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]argcArgument counter.
[in]argvArgument vector.
Returns
The container of the nodes created (or empty container if there was an error).

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

References ns3::TopologyReader::AddLink(), m_linksNumber, m_nodeMap, m_nodesNumber, first::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 ( int  argc,
char *  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]argcArgument counter.
[in]argvArgument vector.
Returns
The container of the nodes created (or empty container if there was an error).

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

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

Referenced by Read().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetFileType()

enum RocketfuelTopologyReader::RF_FileType ns3::RocketfuelTopologyReader::GetFileType ( const char *  line)
private

Classifies the file type according to its content.

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

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

References REGMATCH_MAX, RF_MAPS, RF_UNKNOWN, RF_WEIGHTS, ROCKETFUEL_MAPS_LINE, and ROCKETFUEL_WEIGHTS_LINE.

Referenced by Read().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
The object TypeId

Definition at line 43 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 )
private

Copy constructor.

Defined and unimplemented to avoid misuse.

Returns

◆ Read()

NodeContainer ns3::RocketfuelTopologyReader::Read ( void  )
virtual

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.

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

Implements ns3::TopologyReader.

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

References GenerateFromMapsFile(), GenerateFromWeightsFile(), ns3::TopologyReader::GetFileName(), GetFileType(), first::nodes, NS_LOG_INFO, NS_LOG_WARN, REGMATCH_MAX, RF_MAPS, RF_UNKNOWN, RF_WEIGHTS, ROCKETFUEL_MAPS_LINE, and ROCKETFUEL_WEIGHTS_LINE.

Referenced by RocketfuelTopologyReaderTest::DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_linksNumber

int ns3::RocketfuelTopologyReader::m_linksNumber
private

Number of links.

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

Referenced by GenerateFromMapsFile(), GenerateFromWeightsFile(), and RocketfuelTopologyReader().

◆ m_nodeMap

std::map<std::string, Ptr<Node> > ns3::RocketfuelTopologyReader::m_nodeMap
private

Map of the nodes (name, node).

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

Referenced by GenerateFromMapsFile(), and GenerateFromWeightsFile().

◆ m_nodesNumber

int ns3::RocketfuelTopologyReader::m_nodesNumber
private

Number of nodes.

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

Referenced by GenerateFromMapsFile(), GenerateFromWeightsFile(), and RocketfuelTopologyReader().


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