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

#include "global-value.h"

Public Types
typedef Vector::const_iterator	Iterator
	Iterator type for the list of all global values. More...

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

Ptr< const AttributeChecker >	GetChecker (void) const
	Get the AttributeChecker. More...

std::string	GetHelp (void) const
	Get the help string. More...

std::string	GetName (void) const
	Get the name. More...

void	GetValue (AttributeValue &value) const
	Get the value. More...

void	ResetInitialValue (void)
	Reset to the initial value. More...

bool	SetValue (const AttributeValue &value)
	Set the value of this GlobalValue. More...

Static Public Member Functions
static Iterator	Begin (void)
	The Begin iterator. More...

static void	Bind (std::string name, const AttributeValue &value)
	Iterate over the set of GlobalValues until a matching name is found and then set its value with GlobalValue::SetValue. More...

static bool	BindFailSafe (std::string name, const AttributeValue &value)
	Iterate over the set of GlobalValues until a matching name is found and then set its value with GlobalValue::SetValue. More...

static Iterator	End (void)
	The End iterator. More...

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
	Container type for holding all the GlobalValues. More...

Private Member Functions
void	InitializeFromEnv (void)
	Initialize from the `NS_GLOBAL_VALUE` environment variable. More...

Static Private Member Functions
static Vector *	GetVector (void)
	Get the static vector of all GlobalValues. More...

Private Attributes
Ptr< const AttributeChecker >	m_checker
	The AttributeChecker for this GlobalValue. More...

Ptr< AttributeValue >	m_currentValue
	The current value. More...

std::string	m_help
	The help string. More...

Ptr< AttributeValue >	m_initialValue
	The initial value. More...

std::string	m_name
	The name of this GlobalValue. More...

Friends
class	tests::GlobalValueTestCase

Detailed Description

Hold a so-called 'global value'.

A GlobalValue will get its value from (in order):

The initial value configured where it is defined,
From the NS_GLOBAL_VALUE environment variable,
From the command line,
By explicit call to SetValue() or Bind().

Instances of this class are expected to be allocated as static global variables and should be used to store configurable global state. For example:

// source.cc:
static GlobalValue g_myGlobal =
  GlobalValue ("myGlobal", "My global value for ...",
               IntegerValue (12),
               MakeIntegerChecker ());

GlobalValues can be set directly by calling 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 CommandLine class also get the ability to set global values through command line arguments to their program: –Name=Value will set global value Name to Value.

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

Member Typedef Documentation

◆ Iterator

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

Iterator type for the list of all global values.

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

◆ Vector

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

private

Container type for holding all the GlobalValues.

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

Constructor & Destructor Documentation

◆ GlobalValue()

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

Constructor.

Parameters

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