A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::TopologyReaderHelper Class Reference

Helper class which makes it easier to configure and use a generic TopologyReader. More...

#include <topology-reader-helper.h>

+ Collaboration diagram for ns3::TopologyReaderHelper:

Public Member Functions

 TopologyReaderHelper ()
 
Ptr< TopologyReaderGetTopologyReader ()
 Gets a Ptr<TopologyReader> to the actual TopologyReader. More...
 
void SetFileName (const std::string fileName)
 Sets the input file name. More...
 
void SetFileType (const std::string fileType)
 Sets the input file type. More...
 

Private Attributes

std::string m_fileName
 Name of the input file. More...
 
std::string m_fileType
 Type of the input file (e.g., "Inet", "Orbis", etc.). More...
 
Ptr< TopologyReaderm_inputModel
 Smart pointer to the actual topology model. More...
 

Detailed Description

Helper class which makes it easier to configure and use a generic TopologyReader.

Definition at line 35 of file topology-reader-helper.h.

Constructor & Destructor Documentation

ns3::TopologyReaderHelper::TopologyReaderHelper ( )

Definition at line 34 of file topology-reader-helper.cc.

References m_inputModel.

Member Function Documentation

Ptr< TopologyReader > ns3::TopologyReaderHelper::GetTopologyReader ( )

Gets a Ptr<TopologyReader> to the actual TopologyReader.

Returns
the created Topology Reader (or null if there was an error).

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

References m_fileName, m_fileType, m_inputModel, NS_ASSERT_MSG, and NS_LOG_INFO.

Referenced by main().

+ Here is the caller graph for this function:

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

Sets the input file name.

Parameters
fileNamethe input file name.

Definition at line 40 of file topology-reader-helper.cc.

References m_fileName.

Referenced by main().

+ Here is the caller graph for this function:

void ns3::TopologyReaderHelper::SetFileType ( const std::string  fileType)

Sets the input file type.

Supported file types are "Orbis", "Inet", "Rocketfuel".

Parameters
fileTypethe input file type.

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

References m_fileType.

Referenced by main().

+ Here is the caller graph for this function:

Member Data Documentation

std::string ns3::TopologyReaderHelper::m_fileName
private

Name of the input file.

Definition at line 60 of file topology-reader-helper.h.

Referenced by GetTopologyReader(), and SetFileName().

std::string ns3::TopologyReaderHelper::m_fileType
private

Type of the input file (e.g., "Inet", "Orbis", etc.).

Definition at line 61 of file topology-reader-helper.h.

Referenced by GetTopologyReader(), and SetFileType().

Ptr<TopologyReader> ns3::TopologyReaderHelper::m_inputModel
private

Smart pointer to the actual topology model.

Definition at line 59 of file topology-reader-helper.h.

Referenced by GetTopologyReader(), and TopologyReaderHelper().


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