Introspection did not find any typical Config paths. More...

#include "config-store.h"

Inheritance diagram for ns3::ConfigStore:

Collaboration diagram for ns3::ConfigStore:

Public Types
enum	FileFormat { XML , RAW_TEXT }
	store format More...

enum	Mode { LOAD , SAVE , NONE }
	for ConfigStore operation More...

Public Member Functions
	ConfigStore ()

	~ConfigStore () override

void	ConfigureAttributes ()
	Configure the attribute values.

void	ConfigureDefaults ()
	Configure the default values.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

void	SetFileFormat (FileFormat format)
	Set the file format.

void	SetFilename (std::string filename)
	Set the filename.

void	SetMode (Mode mode)
	Set the mode of operation.

void	SetSaveDeprecated (bool saveDeprecated)
	Set if to save deprecated attributes.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) 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.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Attributes
FileConfig *	m_file
	configuration file

FileFormat	m_fileFormat
	store format

std::string	m_filename
	store file name

Mode	m_mode
	store mode

bool	m_saveDeprecated
	save deprecated attributes

Additional Inherited Members
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 Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Introspection did not find any typical Config paths.

Attributes

FileFormat: Type of file format
- Set with class: ns3::EnumValue
- Underlying type: RawText|Xml
- Initial value: RawText
- Flags: constructwrite
Filename: The file where the configuration should be saved to or loaded from.
- Set with class: ns3::StringValue
- Underlying type: std::string
- Initial value: ""
- Flags: constructwrite
Mode: Configuration mode
- Set with class: ns3::EnumValue
- Underlying type: None|Load|Save
- Initial value: None
- Flags: constructwrite
SaveDeprecated: Save DEPRECATED attributes
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwrite

No TraceSources are defined for this type.
Size of this type is 40 bytes (on a 64-bit architecture).

Definition at line 60 of file config-store.h.

Member Enumeration Documentation

◆ FileFormat

enum ns3::ConfigStore::FileFormat

store format

for ConfigStore operation

file format

Enumerator
XML
RAW_TEXT

Definition at line 79 of file config-store.h.

◆ Mode

enum ns3::ConfigStore::Mode

for ConfigStore operation

store / load mode

Enumerator
LOAD
SAVE
NONE

Definition at line 67 of file config-store.h.

Constructor & Destructor Documentation

◆ ConfigStore()

ns3::ConfigStore::ConfigStore ( )

Definition at line 91 of file config-store.cc.

References ns3::ObjectBase::ConstructSelf(), LOAD, m_file, m_fileFormat, m_filename, m_mode, m_saveDeprecated, NS_ABORT_MSG, NS_LOG_FUNCTION, RAW_TEXT, SAVE, ns3::FileConfig::SetFilename(), ns3::FileConfig::SetSaveDeprecated(), and XML.

Here is the call graph for this function:

◆ ~ConfigStore()

ns3::ConfigStore::~ConfigStore ( )

override

Definition at line 149 of file config-store.cc.

References m_file, and NS_LOG_FUNCTION.

Member Function Documentation

◆ ConfigureAttributes()

void ns3::ConfigStore::ConfigureAttributes ( )

Configure the attribute values.

Definition at line 185 of file config-store.cc.

References ns3::FileConfig::Attributes(), m_file, and NS_LOG_FUNCTION.

Referenced by PrintAttributesIfEnabled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConfigureDefaults()

void ns3::ConfigStore::ConfigureDefaults ( )

Configure the default values.

Definition at line 192 of file config-store.cc.

References ns3::FileConfig::Default(), ns3::FileConfig::Global(), m_file, and NS_LOG_FUNCTION.

Referenced by LteIpv6RoutingTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::ConfigStore::GetInstanceTypeId ( ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.