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

#include "inet-topology-reader.h"

Inheritance diagram for ns3::InetTopologyReader:

Collaboration diagram for ns3::InetTopologyReader:

Public Member Functions
	InetTopologyReader ()

	InetTopologyReader (const InetTopologyReader &)=delete

	~InetTopologyReader () override

InetTopologyReader &	operator= (const InetTopologyReader &)=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

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.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

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, bool permissive=false) 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.

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.

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 Symbols 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 (Inet-format type).

This class takes an input file in Inet format and extracts all the information needed to build the topology (i.e.number of nodes, links and links structure). It have been tested with Inet 3.0 https://web.archive.org/web/20210308100536/http://topology.eecs.umich.edu/inet/

It might set a link attribute named "Weight", corresponding to the euclidean distance between two nodes, the nodes being randomly positioned.

Definition at line 40 of file inet-topology-reader.h.

Constructor & Destructor Documentation

◆ InetTopologyReader() [1/2]

ns3::InetTopologyReader::InetTopologyReader ( )

Definition at line 42 of file inet-topology-reader.cc.

References NS_LOG_FUNCTION.

◆ ~InetTopologyReader()

ns3::InetTopologyReader::~InetTopologyReader ( )

override

Definition at line 47 of file inet-topology-reader.cc.

References NS_LOG_FUNCTION.

◆ InetTopologyReader() [2/2]

ns3::InetTopologyReader::InetTopologyReader ( const InetTopologyReader & )

delete

Member Function Documentation

◆ GetTypeId()

TypeId ns3::InetTopologyReader::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId.

Definition at line 33 of file inet-topology-reader.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ operator=()

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

delete

◆ Read()

NodeContainer ns3::InetTopologyReader::Read ( )

overridevirtual

Main topology reading function.

This method opens an input stream and reads the Inet-format file. From the first line it takes the total number of nodes and links. Then discards a number of rows equals to total nodes (containing useless geographical information). Then reads until the end of the file (total links number rows) and saves the structure of every single link in the topology.

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

Implements ns3::TopologyReader.

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

References ns3::Names::Add(), ns3::TopologyReader::AddLink(), ns3::CreateObject(), ns3::TopologyReader::GetFileName(), nodes, NS_LOG_INFO, and NS_LOG_WARN.