Utilities::Variable< Type > Class Template Reference

#include <utilities.h>

Inheritance diagram for Utilities::Variable< Type >:

Public Member Functions
	Variable ()
	Variable (Type new_reset_value)
virtual	~Variable ()
Type	getValue ()
Type &	getReference ()
void	setValue (Type new_value)
void	setResetValue (Type new_reset_value)
void	resetValue ()
Public Member Functions inherited from Utilities::Dynamic
virtual	~Dynamic ()

Protected Attributes
Type	value
Type	reset_value

Detailed Description

template<typename Type>
class Utilities::Variable< Type >

"Dynamic" variable

Template Parameters

Type	type of variable

Constructor & Destructor Documentation

Variable() [1/2]

template<typename Type >

Utilities::Variable< Type >::Variable

(

)

Variable object default constructor

Returns

none

Variable() [2/2]

template<typename Type >

Utilities::Variable< Type >::Variable

(

Type

new_reset_value

)

Variable object overload constructor

Parameters

new_reset_value

reset value of new variable object

Returns

none

~Variable()

template<typename Type >

virtual Utilities::Variable< Type >::~Variable ( )

virtual

Variable object destructor

Returns

none

Member Function Documentation

getReference()

template<typename Type >

Type & Utilities::Variable< Type >::getReference

(

)

Get reference to variable value

Returns

reference to value for this variable object

getValue()

template<typename Type >

Type Utilities::Variable< Type >::getValue

(

)

Get current variable value

Returns

current value of this variable object

resetValue()

template<typename Type >

void Utilities::Variable< Type >::resetValue

(

)

Reset the current variable value to the reset value

Returns

none

setResetValue()

template<typename Type >

void Utilities::Variable< Type >::setResetValue

(

Type

new_reset_value

)

Set variable reset value

Parameters

new_reset_value

new reset value (e.g. -999; default is the default type constructor)

Returns

none

setValue()

template<typename Type >

void Utilities::Variable< Type >::setValue

(

Type

new_value

)

Set variable value

Parameters

new_value

new value

Returns

none

Member Data Documentation

reset_value

template<typename Type >

Type Utilities::Variable< Type >::reset_value

protected

Variable reset value

value

template<typename Type >

Type Utilities::Variable< Type >::value

protected

Variable value

---

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

• /github/workspace/rapido/src/utilities.h