Detailed Description

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

a globally accessible parameter

A global parameter has the following properties

Available global parameters

Definition at line 20 of file GlobalParam.h.

Public Member Functions
	GlobalParam (T val)

GlobalParam< T > &	operator= (T const &val)
	assign a new value to this parameter

T const	operator() ()
	get the value of the parameter

Public Member Functions inherited from iguana::Object
	Object (std::string_view name="", Logger::Level lev=Logger::DEFAULT_LEVEL)

std::unique_ptr< Logger > &	Log ()

void	SetName (std::string_view name)

std::string	GetName () const

void	SetLogLevel (std::string_view lev)

void	SetLogLevel (Logger::Level const lev)

std::unique_ptr< Logger > &	GetLog ()

Additional Inherited Members
Protected Attributes inherited from iguana::Object
std::string	m_name
	The name of this object.

std::unique_ptr< Logger >	m_log
	`Logger` instance for this object

Inheritance diagram for iguana::GlobalParam< T >:

Constructor & Destructor Documentation

template<typename T >

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

inline

Parameters

val	the initial value of this parameter

Definition at line 25 of file GlobalParam.h.

template<typename T >

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

inline

get the value of the parameter

Definition at line 40 of file GlobalParam.h.

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

Definition at line 31 of file GlobalParam.h.

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