A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::RawTextConfigLoad Class Reference

A class to enable loading of configuration store from a raw text file. More...

#include "raw-text-config.h"

+ Inheritance diagram for ns3::RawTextConfigLoad:
+ Collaboration diagram for ns3::RawTextConfigLoad:

Public Member Functions

 RawTextConfigLoad ()
 default constructor
 
 ~RawTextConfigLoad () override
 destructor
 
void Attributes () override
 Load or save the attributes values.
 
void Default () override
 Load or save the default values.
 
void Global () override
 Load or save the global values.
 
void SetFilename (std::string filename) override
 Set the file name.
 
- Public Member Functions inherited from ns3::FileConfig
virtual ~FileConfig ()
 

Private Member Functions

virtual bool ParseLine (const std::string &line, std::string &type, std::string &name, std::string &value)
 Parse (potentially multi-) line configs into type, name, and values.
 
std::string Strip (std::string value)
 Strip out attribute value.
 

Private Attributes

std::ifstream * m_is
 Config store input stream.
 

Detailed Description

A class to enable loading of configuration store from a raw text file.

Definition at line 46 of file raw-text-config.h.

Constructor & Destructor Documentation

◆ RawTextConfigLoad()

ns3::RawTextConfigLoad::RawTextConfigLoad ( )

default constructor

Definition at line 199 of file raw-text-config.cc.

References NS_LOG_FUNCTION.

◆ ~RawTextConfigLoad()

ns3::RawTextConfigLoad::~RawTextConfigLoad ( )
override

destructor

Definition at line 205 of file raw-text-config.cc.

References m_is, and NS_LOG_FUNCTION.

Member Function Documentation

◆ Attributes()

void ns3::RawTextConfigLoad::Attributes ( )
overridevirtual

Load or save the attributes values.

Implements ns3::FileConfig.

Definition at line 292 of file raw-text-config.cc.

References m_is, NS_LOG_DEBUG, NS_LOG_FUNCTION, ParseLine(), ns3::Config::Set(), and Strip().

Referenced by ns3::load_clicked_attribute().

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

◆ Default()

void ns3::RawTextConfigLoad::Default ( )
overridevirtual

Load or save the default values.

Implements ns3::FileConfig.

Definition at line 236 of file raw-text-config.cc.

References m_is, NS_LOG_DEBUG, NS_LOG_FUNCTION, ParseLine(), ns3::Config::SetDefault(), and Strip().

Referenced by ns3::load_clicked_default().

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

◆ Global()

void ns3::RawTextConfigLoad::Global ( )
overridevirtual

Load or save the global values.

Implements ns3::FileConfig.

Definition at line 264 of file raw-text-config.cc.

References m_is, NS_LOG_DEBUG, NS_LOG_FUNCTION, ParseLine(), ns3::Config::SetGlobal(), and Strip().

+ Here is the call graph for this function:

◆ ParseLine()

bool ns3::RawTextConfigLoad::ParseLine ( const std::string & line,
std::string & type,
std::string & name,
std::string & value )
privatevirtual

Parse (potentially multi-) line configs into type, name, and values.

This will return false for blank lines, comments (lines beginning with '#'), and incomplete entries. An entry is considered complete when a type and name have been found and the value contains two delimiting quotation marks '"'.

Parameters
linethe config file line
typethe config type {default, global, value}
namethe config attribute name
valuethe value to set
Returns
true if all of type, name, and value parsed; false otherwise

Definition at line 320 of file raw-text-config.cc.

References NS_LOG_FUNCTION.

Referenced by Attributes(), Default(), and Global().

+ Here is the caller graph for this function:

◆ SetFilename()

void ns3::RawTextConfigLoad::SetFilename ( std::string filename)
overridevirtual

Set the file name.

Parameters
filenamethe filename

Implements ns3::FileConfig.

Definition at line 217 of file raw-text-config.cc.

References m_is, and NS_LOG_FUNCTION.

Referenced by ns3::load_clicked_attribute(), and ns3::load_clicked_default().

+ Here is the caller graph for this function:

◆ Strip()

std::string ns3::RawTextConfigLoad::Strip ( std::string value)
private

Strip out attribute value.

Parameters
valuethe input string
Returns
the updated string

Definition at line 225 of file raw-text-config.cc.

References NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.

Referenced by Attributes(), Default(), and Global().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_is

std::ifstream* ns3::RawTextConfigLoad::m_is
private

Config store input stream.

Definition at line 82 of file raw-text-config.h.

Referenced by ~RawTextConfigLoad(), Attributes(), Default(), Global(), and SetFilename().


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