API Documentation

ParameterValue Class

This class is a wrapper to a union.

ParameterValue parameter;

parameter.setParameterValueKind( PARAMETER_VALUE_DOUBLE );

parameter.setDValue( 3.14 );

ParameterValue::ParameterValue ( )

A default constructor.

ParameterValue::ParameterValue ( … )

A copy constructor.

Parameters
in/out type description
in const datamode::ParameterValue & Instance being copied.

ParameterValue::ParameterValue ( … )

A convenience constructor from a related type.

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

ParameterValue::~ParameterValue ( )

A default destructor.

ParameterValue::print ( … )

This will print internal values.

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

Returns

  • void

ParameterValue::get_ps_parameter_value ( ) const

This will provide convenient access to a related type.

Returns

ParameterValue::operator= ( … )

An assignment operator.

Parameters
in/out type description
in const datamode::ParameterValue & Instance to copy.
Returns

ParameterValue::setParameterValueKind ( … )

This will set the type of the contained value.

Parameters
in/out type description
in ps_parameter_value_kind The type of the contained value.
Returns
  • void

ParameterValue::getParameterValueKind ( )

This will get the type of the contained value.

Returns

ParameterValue::setUllValue ( … )

This will set the contained value to a provided unsigned long long value.

Parameters
in/out type description
in unsigned long long The new contained value.
Returns
  • void

ParameterValue::getUllValue ( ) const

This will get the contained unsigned long long value.

Returns
  • unsigned long long

ParameterValue::setLlValue ( … )

This will set the contained value to a provided long long value.

Parameters
in/out type description
in long long The new contained value.
Returns
  • void

ParameterValue::getLlValue ( ) const

This will get the contained long long value.

Returns
  • long long

ParameterValue::setDValue ( … )

This will set the contained value to a provided double value.

Parameters
in/out type description
in double The new contained value.

ParameterValue::getDValue ( ) const

This will get the contained double value.

Returns
  • double

ParameterValue::setStrValue ( … )

This will set the contained value to the provided std::string.

Parameters
in/out type description
in const std::string & The new contained value.
Returns
  • void

ParameterValue::getStrValue ( ) const

Returns
  • std::string