iguana::GlobalParam< T > Class Template Reference

#include <GlobalParam.h>

Detailed Description

template<typename T>
class iguana::GlobalParam< T >

a globally accessible parameter

A global parameter has the following properties

• a default value
• may be changed only one time
• may be read from anywhere

Available global parameters

• iguana::GlobalConcurrencyModel

Definition at line 20 of file GlobalParam.h.

Public Member Functions
	GlobalParam (T val)
T const	operator() ()
	get the value of the parameter
GlobalParam< T > &	operator= (T const &val)
	assign a new value to this parameter
Public Member Functions inherited from iguana::Object
std::unique_ptr< Logger > &	GetLog ()
std::string	GetName () const
std::unique_ptr< Logger > &	Log ()
	Object (std::string_view name="", Logger::Level lev=Logger::DEFAULT_LEVEL)
void	SetLogLevel (Logger::Level const lev)
void	SetLogLevel (std::string_view lev)
void	SetName (std::string_view name)

Additional Inherited Members
Protected Attributes inherited from iguana::Object
std::unique_ptr< Logger >	m_log
	Logger instance for this object
std::string	m_name
	The name of this object.

Inheritance diagram for iguana::GlobalParam< T >:

Constructor & Destructor Documentation

GlobalParam()

template<typename T>

iguana::GlobalParam< T >::GlobalParam ( T val )

inline

Parameters

val	the initial value of this parameter

Definition at line 26 of file GlobalParam.h.

Member Function Documentation

operator()()

template<typename T>

T const iguana::GlobalParam< T >::operator() ( )

inline

get the value of the parameter

Returns

the value of the parameter

Definition at line 44 of file GlobalParam.h.

operator=()

template<typename T>

GlobalParam< T > & iguana::GlobalParam< T >::operator= ( T const & val )

inline

assign a new value to this parameter

Warning

this may only be used one time; a second attempt to set the parameter will fail

Parameters

val	the new value of this parameter

Returns

*this

Definition at line 35 of file GlobalParam.h.

---

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

• /__w/iguana/iguana/iguana_src/src/iguana/services/GlobalParam.h