API Documentation

SdfSensorConfiguration Class

The Sensor Configuration from the System Design File.

SdfSensorConfiguration::SdfSensorConfiguration ( )

A default constructor.

SdfSensorConfiguration::SdfSensorConfiguration ( … )

A copy constructor.

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

SdfSensorConfiguration::SdfSensorConfiguration ( … )

A convenience constructor from a related type.

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

SdfSensorConfiguration::~SdfSensorConfiguration ( )

A default destructor.

SdfSensorConfiguration::print ( … )

This will print internal values.

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

SdfSensorConfiguration::get_ps_sdf_sensor_configuration ( ) const

This will provide convenient access to a related type.

Returns

SdfSensorConfiguration::operator= ( … )

An assignment operator.

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

SdfSensorConfiguration::getId ( ) const

This will get the identifier of the configuration.

Returns
  • unsigned long

SdfSensorConfiguration::getNodeConfigurationId ( ) const

This will get the identifier of the parent node configuration.

Returns
  • unsigned long

SdfSensorConfiguration::getParameterListId ( ) const

This will get the identifier of the parameter list.

Returns
  • unsigned long

SdfSensorConfiguration::getSensorTypeId ( ) const

This will get the identifier of the sensor type.

Returns
  • unsigned long

SdfSensorConfiguration::getName ( ) const

This will get the name of the configuration.

Returns
  • std::string

SdfSensorConfiguration::getIoConfigs ( ) const

This will get the vector of the child SdfIoConfiguration.

Returns

SdfSensorConfiguration::getParameterValues ( ) const

This will get the vector of the parameter values.

Returns

SdfSensorConfiguration::setId ( … )

This will set the identifier of the configuration.

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

SdfSensorConfiguration::setNodeConfigurationId ( … )

This will set the identifier of the parent node configuration.

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

SdfSensorConfiguration::setNodeConfigurationId ( … )

This will set the identifier of the parent node configuration.

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

SdfSensorConfiguration::setParameterListId ( … )

This will set the identifier of the parameter list.

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

SdfSensorConfiguration::setSensorTypeId ( … ) const

This will set the identifier of the sensor type.

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

SdfSensorConfiguration::setName ( … )

This will set the name of the configuration.

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

SdfSensorConfiguration::setIoConfigs ( … )

This will set the vector of the child SdfIoConfiguration.

Parameters
in/out type description
in const std::vector< SdfIoConfiguration > & The set child configurations.
Returns
  • void

SdfSensorConfiguration::setParameterValues ( … )

This will set the vector of the parameter values.

Parameters
in/out type description
in const std::vector< SdfParameterValue > & The set parameter values.
Returns
  • void