lucid::ParameterValues Class Reference

Collection of parameter values used in a configurable system or application. More...

#include <ParameterValues.h>

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

Private Attributes
Parameter	parameter_
	Parameter the values are assigned to.
std::size_t	size_
	Number of values assigned to the parameter.
ParameterValuesType	values_
	All values assigned to the parameter.

Detailed Description

Collection of parameter values used in a configurable system or application.

It associates with the same parameter an arbitrarily large number of values. All values must have the same type, but the type can be different for each parameter.

Constructor & Destructor Documentation

ParameterValues() [1/3]

lucid::ParameterValues::ParameterValues ( const Parameter parameter, std::vector< double > values )

inline

Construct a new ParameterValues object for the given parameter associated with the given values.

Parameters

parameter	parameter to set
values	all values assigned to the parameter

ParameterValues() [2/3]

lucid::ParameterValues::ParameterValues ( const Parameter parameter, std::vector< int > values )

inline

Construct a new ParameterValues object for the given parameter associated with the given values.

Parameters

parameter	parameter to set
values	all values assigned to the parameter

ParameterValues() [3/3]

lucid::ParameterValues::ParameterValues ( const Parameter parameter, std::vector< Vector > values )

inline

Construct a new ParameterValues object for the given parameter associated with the given values.

Parameters

parameter	parameter to set
values	all values assigned to the parameter

Member Function Documentation

get()

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

const std::vector< T > & lucid::ParameterValues::get ( ) const

inlinenodiscard

Get the values of this parameter.

Template Parameters

T	type of the value to retrieve

Returns

value of the parameter

operator==()

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

nodiscard

Compare two parameter values 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::ParameterValues::parameter ( ) const

inlinenodiscard

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

Returns

parameter of the parameter values

size()

std::size_t lucid::ParameterValues::size ( ) const

inlinenodiscard

Get read-only access to the size of the parameter values.

Returns

size of the parameter values

values()

const ParameterValuesType & lucid::ParameterValues::values ( ) const

inlinenodiscard

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

Returns

values of the parameter values

---

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

• lucid/model/ParameterValues.h
• lucid/model/ParameterValues.cpp