lucid::ParameterValue Class Reference

Parameter value used in a configurable system or application. More...

#include <ParameterValue.h>

Public Member Functions
	ParameterValue (const Parameter parameter, double value)
	Construct a new ParameterValue object for the given parameter associated with the given value.
	ParameterValue (const Parameter parameter, int value)
	Construct a new ParameterValue object for the given parameter associated with the given value.
	ParameterValue (const Parameter parameter, Vector value)
	Construct a new ParameterValue object for the given parameter associated with the given value.
Parameter	parameter () const
	Get read-only access to the parameter of the parameter value.
const ParameterValueType &	value () const
	Get read-only access to the value of the parameter value.
template<IsAnyOf< int, double, Vector > T>
const T &	get () const
	Get the value of this parameter.
bool	operator== (const ParameterValue &o) const
	Compare two parameter value objects to determine if they are equal.

Private Attributes
Parameter	parameter_
	Parameter associated with the value.
ParameterValueType	value_
	Value assigned to the parameter.

Detailed Description

Parameter value used in a configurable system or application.

It associates to the same parameter a single value. The value can be of different types, i.e., int, double, and eigen Vectors.

Constructor & Destructor Documentation

ParameterValue() [1/3]

lucid::ParameterValue::ParameterValue ( const Parameter parameter, double value )

inline

Construct a new ParameterValue object for the given parameter associated with the given value.

Parameters

parameter	parameter to set
value	value assigned to the parameter

ParameterValue() [2/3]

lucid::ParameterValue::ParameterValue ( const Parameter parameter, int value )

inline

Construct a new ParameterValue object for the given parameter associated with the given value.

Parameters

parameter	parameter to set
value	value assigned to the parameter

ParameterValue() [3/3]

lucid::ParameterValue::ParameterValue ( const Parameter parameter, Vector value )

inline

Construct a new ParameterValue object for the given parameter associated with the given value.

Parameters

parameter	parameter to set
value	value assigned to the parameter

Member Function Documentation

get()

template<IsAnyOf< int, double, Vector > T>

const T & lucid::ParameterValue::get ( ) const

inlinenodiscard

Get the value of this parameter.

Template Parameters

T	type of the value to retrieve

Returns

value of the parameter

operator==()

bool lucid::ParameterValue::operator== ( const ParameterValue & o ) const

nodiscard

Compare two parameter value objects to determine if they are equal.

Parameters

o	other object to compare against

Returns

true the two object are equal

false if the two objects are different

parameter()

Parameter lucid::ParameterValue::parameter ( ) const

inlinenodiscard

Get read-only access to the parameter of the parameter value.

Returns

parameter of the parameter value

value()

const ParameterValueType & lucid::ParameterValue::value ( ) const

inlinenodiscard

Get read-only access to the value of the parameter value.

Returns

value of the parameter value

---

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

• lucid/model/ParameterValue.h
• lucid/model/ParameterValue.cpp