API Documentation

Parameter Class

The Parameter Class.

Parameter::Parameter ( )

A default constructor.

Parameter::Parameter ( … )

A copy constructor.

Parameters
in/out type description
in const Parameter & Instance being copied.

Parameter::Parameter ( … )

A convenience constructor from a related type.

Parameters
in/out type description
in const ps_parameter & Instance of related type.

Parameter::~Parameter ( )

A default destructor.

Parameter::print ( … )

This will print internal values.

Parameters
in/out type description
in std::ostream & Output stream that defaults to std::cout.
Returns
  • void

Parameter::get_ps_parameter ( ) const

This will provide convenient access to a related type.

Returns

Parameter::operator= ( … )

An assignment operator.

Parameters
in/out type description
in const Parameter & Instance to copy.
Returns

Parameter::getId ( ) const;

This will get the parameter identifier.

Returns

Parameter::getTimestamp ( ) const;

This will get the measurement timestamp.

Returns

Parameter::getValue ( ) const;

This will get the parameter value.

Returns

Parameter::getMin ( ) const;

This will get the parameter minimum value.

If the ps_parameter_value_kind is PARAMETER_VALUE_UNKNOWN, then the parameter does not enforce a minimum.

Returns

Parameter::getMax ( ) const;

This will get the parameter maximum value.

If the ps_parameter_value_kind is PARAMETER_VALUE_UNKNOWN, then the parameter does not enforce a maximum.

Returns

Parameter::getStep ( ) const;

This will get the parameter step value.

If the ps_parameter_value_kind is PARAMETER_VALUE_UNKNOWN, then the parameter does not enforce a step.

Returns

Parameter::getFlags ( ) const;

This will get the byte representing the parameter’s flags.

Returns
  • unsigned char

Parameter::getDescription ( ) const;

This will get the string description of the parameter.

Returns
  • std::string

Parameter::setId ( … )

This will get the parameter identifier.

Parameters
in/out type description
in ps_parameter_id The parameter identifier.
Returns
  • void

Parameter::setTimestamp ( … )

This will set the measurement timestamp.

Parameters
in/out type description
in ps_timestamp The parameter timestamp.
Returns
  • void

Parameter::setValue ( … )

This will set the parameter value.

Parameters
in/out type description
in const datamode::ParameterValue & The parameter value.
Returns
  • void

Parameter::setMin ( … )

This will set the parameter minimum.

Parameters
in/out type description
in const datamode::ParameterValue & The parameter minimum.
Returns
  • void

Parameter::setMax ( … )

This will set the parameter maximum.

Parameters
in/out type description
in const datamode::ParameterValue & The parameter maximum.
Returns
  • void

Parameter::setStep ( … )

This will set the measurement timestamp.

Parameters
in/out type description
in const datamode::ParameterValue & The parameter step.
Returns
  • void

Parameter::setFlags ( … )

This will set the parameter flags byte.

Parameters
in/out type description
in unsigned char The parameter flags byte field.
Returns
  • void

Parameter::setDescription ( … )

This will set the parameter description.

Parameters
in/out type description
in const std::string & The description of the parameter to set.
Returns
  • void