API Documentation

SdfParameterValue Class

The System Design File Parameter Value Class.

SdfParameterValue::SdfParameterValue ( )

A default constructor.

SdfParameterValue::SdfParameterValue ( … )

A copy constructor.

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

SdfParameterValue::SdfParameterValue ( … )

A convenience constructor from a related type.

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

SdfParameterValue::~SdfParameterValue ( )

A default destructor.

SdfParameterValue::print ( … )

This will print internal values.

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

SdfParameterValue::get_ps_sdf_parameter_value ( ) const

This will provide convenient access to a related type.

Returns

SdfParameterValue::operator= ( … )

An assignment operator.

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

SdfParameterValue::getId ( ) const

This will get the primary identifier of the parameter value in the System Design File.

Returns
  • unsigned long

SdfParameterValue::getParameterListId ( ) const

This will get the identifier of the parent parameter list.

Returns
  • unsigned long

SdfParameterValue::getParameterDescriptionId ( ) const

This will get the identifier of the parameter description.

Returns
  • unsigned long

SdfParameterValue::getParameter ( ) const

This will get the parameter.

Returns

SdfParameterValue::getParameterId ( ) const

This will get the identifier of the parameter.

Returns

SdfParameterValue::getParameterTimestamp ( ) const

This will get the timestamp of the parameter.

Returns

SdfParameterValue::getParameterValue ( ) const

This will get the parameter value.

Returns

SdfParameterValue::getParameterMin ( ) const

This will get the parameter minimum.

Returns

SdfParameterValue::getParameterMax ( ) const

This will get the parameter maximum.

Returns

SdfParameterValue::getParameterStep ( ) const

This will get the parameter step.

Returns

SdfParameterValue::getParameterFlags ( ) const

This will get the parameter flags byte field.

Returns
  • unsigned char

SdfParameterValue::getParameterDescription ( ) const

This will get the parameter’s string description.

Returns
  • std::string

SdfParameterValue::setId ( … )

This will set the primary identifier of the parameter value for the System Design File.

Parameters
in/out type description
in unsigned long The primary identifier.
Returns
  • void

SdfParameterValue::setParameterListId ( … )

This will set the identifier of the parent parameter list.

Parameters
in/out type description
in unsigned long The parameter list identifier.
Returns
  • void

SdfParameterValue::setParameterDescriptionId ( … )

This will set the parameter description identifier.

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

SdfParameterValue::setParameter ( … )

This will set the parameter.

Parameters
in/out type description
in Parameter The new parameter.
Returns
  • void

SdfParameterValue::setParameterId ( … )

This will set the parameter identifier.

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

SdfParameterValue::setParameterTimestamp ( … )

This will set the timestamp of the parameter.

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

SdfParameterValue::setParameterValue ( … )

This will set the parameter value.

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

SdfParameterValue::setParameterMin ( … )

This will set the parameter minimum.

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

SdfParameterValue::setParameterMax ( … )

This will set the parameter maximum.

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

SdfParameterValue::setParameterStep ( … )

This will set the parameter step.

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

SdfParameterValue::setParameterFlags ( … )

This will set the parameter flags byte field.

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

SdfParameterValue::setParameterDescription ( … )

This will set the parameter description.

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