hold a so-called 'global value'. More...

#include <global-value.h>

Collaboration diagram for ns3::GlobalValue:

Public Types
typedef Vector::const_iterator	Iterator

Public Member Functions
	GlobalValue (std::string name, std::string help, const AttributeValue &initialValue, Ptr< const AttributeChecker > checker)

Ptr< const AttributeChecker >	GetChecker (void) const

std::string	GetHelp (void) const

std::string	GetName (void) const

void	GetValue (AttributeValue &value) const

void	ResetInitialValue (void)

bool	SetValue (const AttributeValue &value)

Static Public Member Functions
static Iterator	Begin (void)

static void	Bind (std::string name, const AttributeValue &value)

static bool	BindFailSafe (std::string name, const AttributeValue &value)

static Iterator	End (void)

static void	GetValueByName (std::string name, AttributeValue &value)
	finds the GlobalValue with the given name and returns its value. More...

static bool	GetValueByNameFailSafe (std::string name, AttributeValue &value)
	finds the GlobalValue with the given name and returns its value More...

Private Types
typedef std::vector< GlobalValue * >	Vector

Private Member Functions
void	InitializeFromEnv (void)

Static Private Member Functions
static Vector *	GetVector (void)

Private Attributes
Ptr< const AttributeChecker >	m_checker

Ptr< AttributeValue >	m_currentValue

std::string	m_help

Ptr< AttributeValue >	m_initialValue

std::string	m_name

Friends
class	::GlobalValueTestCase

Detailed Description

hold a so-called 'global value'.

Instances of this class are expected to be allocated as static global variables and should be used to store configurable global state. GlobalValues can be set directly by calling ns3::GlobalValue::SetValue but they can also be set through the NS_GLOBAL_VALUE environment variable. For example, NS_GLOBAL_VALUE='Name=Value;OtherName=OtherValue;' would set global values Name and OtherName to Value and OtherValue respectively.

Users of the ns3::CommandLine class also get the ability to set global values through commandline arguments to their program: –Name=Value will set global value Name to Value.

Definition at line 48 of file global-value.h.

Member Typedef Documentation

typedef Vector::const_iterator ns3::GlobalValue::Iterator

Definition at line 52 of file global-value.h.

typedef std::vector<GlobalValue *> ns3::GlobalValue::Vector

private

Definition at line 50 of file global-value.h.

Constructor & Destructor Documentation

ns3::GlobalValue::GlobalValue	(	std::string	name,
		std::string	help,
		const AttributeValue &	initialValue,
		Ptr< const AttributeChecker >	checker
	)

Parameters

name	the name of this global value.
help	some help text which describes the purpose of this global value.
initialValue	the value to assign to this global value during construction.
checker	a pointer to an AttributeChecker which can verify that any user-supplied value to override the initial value matches the requested type constraints.

Definition at line 36 of file global-value.cc.

References GetVector(), InitializeFromEnv(), m_checker, m_currentValue, m_initialValue, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Here is the call graph for this function: