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, 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::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 Symbols 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<ns3::ConfigStore::FileFormat>
- Underlying type: RawText|Xml
- Initial value: RawText
- Flags: constructwrite
- Support level: SUPPORTED
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
- Support level: SUPPORTED
Mode: Configuration mode
- Set with class: ns3::EnumValue<ns3::ConfigStore::Mode>
- Underlying type: None|Load|Save
- Initial value: None
- Flags: constructwrite
- Support level: SUPPORTED
SaveDeprecated: Save DEPRECATED attributes
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwrite
- Support level: OBSOLETE: OBSOLETE since ns-3.43 as it is no longer needed; deprecated attributes are saved only if their value differs from their respective original initial value

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

Definition at line 49 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 68 of file config-store.h.

◆ Mode

enum ns3::ConfigStore::Mode

for ConfigStore operation

store / load mode

Enumerator
LOAD
SAVE
NONE

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

Constructor & Destructor Documentation

◆ ConfigStore()

ns3::ConfigStore::ConfigStore ( )

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

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

Here is the call graph for this function:

◆ ~ConfigStore()

ns3::ConfigStore::~ConfigStore ( )

override

Definition at line 139 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 175 of file config-store.cc.

References m_file, and NS_LOG_FUNCTION.

Referenced by PrintAttributesIfEnabled().

Here is the caller graph for this function:

◆ ConfigureDefaults()

void ns3::ConfigStore::ConfigureDefaults ( )

Configure the default values.

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

References m_file, and NS_LOG_FUNCTION.

Referenced by LteIpv6RoutingTestCase::DoRun().

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 provided by ns3::Object::GetInstanceTypeId but classes which derive from ns3::ObjectBase directly have to implement it themselves. Typically, this method should simply return the output of GetTypeId().

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

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

References GetTypeId().

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::ConfigStore::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

References LOAD, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeStringAccessor(), ns3::MakeStringChecker(), NONE, ns3::TypeId::OBSOLETE, RAW_TEXT, SAVE, SetFileFormat(), SetFilename(), SetMode(), ns3::TypeId::SetParent(), SetSaveDeprecated(), and XML.

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetFileFormat()

void ns3::ConfigStore::SetFileFormat ( FileFormat format )

Set the file format.

Parameters

format the file format

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

References m_fileFormat, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetFilename()

void ns3::ConfigStore::SetFilename ( std::string filename )

Set the filename.

Parameters

filename the file name

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

References m_filename, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetMode()

void ns3::ConfigStore::SetMode ( Mode mode )

Set the mode of operation.

Parameters

mode	mode of operation

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

References m_mode, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetSaveDeprecated()

void ns3::ConfigStore::SetSaveDeprecated ( bool saveDeprecated )

Set if to save deprecated attributes.

Parameters

saveDeprecated the deprecated attributes save policy

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

References m_saveDeprecated, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

Member Data Documentation

◆ m_file

FileConfig* ns3::ConfigStore::m_file

private

configuration file

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

Referenced by ConfigStore(), ~ConfigStore(), ConfigureAttributes(), and ConfigureDefaults().

◆ m_fileFormat

FileFormat ns3::ConfigStore::m_fileFormat

private

store format

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

Referenced by ConfigStore(), and SetFileFormat().

◆ m_filename

std::string ns3::ConfigStore::m_filename

private

store file name

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

Referenced by ConfigStore(), and SetFilename().

◆ m_mode

Mode ns3::ConfigStore::m_mode

private

store mode

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

Referenced by ConfigStore(), and SetMode().

◆ m_saveDeprecated

bool ns3::ConfigStore::m_saveDeprecated

private

save deprecated attributes

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

Referenced by SetSaveDeprecated().

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

src/config-store/model/config-store.h
src/config-store/model/config-store.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes

Member Enumeration Documentation

◆ FileFormat

◆ Mode

Constructor & Destructor Documentation

◆ ConfigStore()

◆ ~ConfigStore()

Member Function Documentation

◆ ConfigureAttributes()

◆ ConfigureDefaults()

◆ GetInstanceTypeId()

◆ GetTypeId()

◆ SetFileFormat()

◆ SetFilename()

◆ SetMode()

◆ SetSaveDeprecated()

Member Data Documentation

◆ m_file

◆ m_fileFormat

◆ m_filename

◆ m_mode

◆ m_saveDeprecated