Interface for input file readers management. More...
#include "topology-reader.h"
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 | |
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. | |
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::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Attributes | |
std::string | m_fileName |
The name of the input file. | |
std::list< Link > | m_linksList |
The container of the links between the nodes. | |
Additional Inherited Members | |
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. | |
Interface for input file readers management.
Introspection did not find any typical Config paths.
This interface perform the shared tasks among all possible input file readers. Each different file format is handled by its own topology reader.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: TopologyReader
Size of this type is 112 bytes (on a 64-bit architecture).
Definition at line 39 of file topology-reader.h.
typedef std::list<Link>::const_iterator ns3::TopologyReader::ConstLinksIterator |
Constant iterator to the list of the links.
Definition at line 133 of file topology-reader.h.
ns3::TopologyReader::TopologyReader | ( | ) |
Definition at line 35 of file topology-reader.cc.
References NS_LOG_FUNCTION.
|
override |
Definition at line 40 of file topology-reader.cc.
References NS_LOG_FUNCTION.
|
delete |
void ns3::TopologyReader::AddLink | ( | Link | link | ) |
Adds a link to the topology.
link | [in] The link to be added. |
Definition at line 84 of file topology-reader.cc.
References m_linksList.
Referenced by ns3::RocketfuelTopologyReader::GenerateFromMapsFile(), ns3::RocketfuelTopologyReader::GenerateFromWeightsFile(), ns3::InetTopologyReader::Read(), and ns3::OrbisTopologyReader::Read().
std::string ns3::TopologyReader::GetFileName | ( | ) | const |
Returns the input file name.
Definition at line 52 of file topology-reader.cc.
References m_fileName.
Referenced by ns3::InetTopologyReader::Read(), ns3::OrbisTopologyReader::Read(), and ns3::RocketfuelTopologyReader::Read().
|
static |
Get the type ID.
Definition at line 28 of file topology-reader.cc.
References ns3::TypeId::SetParent().
TopologyReader::ConstLinksIterator ns3::TopologyReader::LinksBegin | ( | ) | const |
Returns an iterator to the the first link in this block.
Definition at line 60 of file topology-reader.cc.
References m_linksList.
Referenced by ns3::RocketfuelTopologyReader::GenerateFromWeightsFile().
bool ns3::TopologyReader::LinksEmpty | ( | ) | const |
Checks if the block contains any links.
Definition at line 78 of file topology-reader.cc.
References m_linksList.
TopologyReader::ConstLinksIterator ns3::TopologyReader::LinksEnd | ( | ) | const |
Returns an iterator to the the last link in this block.
Definition at line 66 of file topology-reader.cc.
References m_linksList.
Referenced by ns3::RocketfuelTopologyReader::GenerateFromWeightsFile().
int ns3::TopologyReader::LinksSize | ( | ) | const |
Returns the number of links in this block.
Definition at line 72 of file topology-reader.cc.
References m_linksList.
|
delete |
|
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.
Implemented in ns3::InetTopologyReader, ns3::OrbisTopologyReader, and ns3::RocketfuelTopologyReader.
void ns3::TopologyReader::SetFileName | ( | const std::string & | fileName | ) |
Sets the input file name.
[in] | fileName | The input file name. |
Definition at line 46 of file topology-reader.cc.
References m_fileName.
|
private |
The name of the input file.
Definition at line 207 of file topology-reader.h.
Referenced by GetFileName(), and SetFileName().
|
private |
The container of the links between the nodes.
Definition at line 212 of file topology-reader.h.
Referenced by AddLink(), LinksBegin(), LinksEmpty(), LinksEnd(), and LinksSize().