Parameter Class Reference

Inheritance diagram for Parameter:

Public Member Functions
	Parameter (const string &name, float val=NAN_F)
bool	IsLinked () const
void	SetAsLinked (bool value=true)
string	GetName () const
void	SetName (const string &name)
float	GetValue () const
float *	GetValuePointer ()
void	SetValue (float val)

Protected Attributes
bool	m_linked
string	m_name
float	m_value

Member Function Documentation

GetName()

string Parameter::GetName ( ) const

inline

Get the name of the parameter.

Returns

the name of the parameter.

GetValue()

float Parameter::GetValue ( ) const

inline

Get the parameter value.

Returns

the parameter value.

GetValuePointer()

float * Parameter::GetValuePointer ( )

inline

Get the pointer to the parameter value.

Returns

pointer to the parameter value.

IsLinked()

bool Parameter::IsLinked ( ) const

inline

Check if the parameter is linked to a process.

Returns

true if the parameter is linked to a process.

SetAsLinked()

void Parameter::SetAsLinked ( bool value = true )

inline

Set the parameter as linked to a process.

Parameters

value

true if the parameter is linked to a process.

SetName()

void Parameter::SetName ( const string & name )

inline

Set the name of the parameter.

Parameters

name	the name of the parameter.

SetValue()

void Parameter::SetValue ( float val )

inline

Set the parameter value.

Parameters

val	the parameter value.

---

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

• /github/workspace/core/src/base/Parameter.h
• /github/workspace/core/src/base/Parameter.cpp