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< TopologyReader >	GetTopologyReader ()
	Gets a Ptr<TopologyReader> to the actual TopologyReader.
void	SetFileName (const std::string fileName)
	Sets the input file name.
void	SetFileType (const std::string fileType)
	Sets the input file type.

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

Detailed Description

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

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

Constructor & Destructor Documentation

TopologyReaderHelper()

ns3::TopologyReaderHelper::TopologyReaderHelper

(

)

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

References m_inputModel.

Member Function Documentation

GetTopologyReader()

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 58 of file topology-reader-helper.cc.

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

SetFileName()

void ns3::TopologyReaderHelper::SetFileName

(

const std::string

fileName

)

Sets the input file name.

Parameters

[in]

fileName

The input file name.

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

References m_fileName.

SetFileType()

void ns3::TopologyReaderHelper::SetFileType

(

const std::string

fileType

)

Sets the input file type.

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

Parameters

[in]

fileType

The input file type.

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

References m_fileType.

Member Data Documentation

m_fileName

std::string ns3::TopologyReaderHelper::m_fileName

private

Name of the input file.

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

Referenced by GetTopologyReader(), and SetFileName().

m_fileType

std::string ns3::TopologyReaderHelper::m_fileType

private

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

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

Referenced by GetTopologyReader(), and SetFileType().

m_inputModel

Ptr<TopologyReader> ns3::TopologyReaderHelper::m_inputModel

private

Smart pointer to the actual topology model.

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

Referenced by TopologyReaderHelper(), and GetTopologyReader().

---

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

• src/topology-read/helper/topology-reader-helper.h
• src/topology-read/helper/topology-reader-helper.cc