API Documentation

SdfSensorDescriptor Class

The Sensor descriptor from the System Design File.

SdfSensorDescriptor::SdfSensorDescriptor ( )

A default constructor.

SdfSensorDescriptor::SdfSensorDescriptor ( … )

A copy constructor.

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

SdfSensorDescriptor::SdfSensorDescriptor ( … )

The convenience constructor from a related type.

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

SdfSensorDescriptor::~SdfSensorDescriptor ( )

A default destructor.

SdfSensorDescriptor::print ( … )

This will print internal values.

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

SdfSensorDescriptor::get_ps_sdf_sensor_descriptor ( ) const

This will provide convenient access to a related type.

Returns

SdfSensorDescriptor::operator= ( … )

An assignment operator.

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

SdfSensorDescriptor::getSensorType ( ) const

This will get the type of the sensor.

Returns

SdfSensorDescriptor::getName ( ) const

This will get the name of the sensor.

Returns
  • std::string

SdfSensorDescriptor::getDescription ( ) const

This will get the description of the sensor.

Returns
  • std::string

SdfSensorDescriptor::setSensorType ( … )

This will set the type of the sensor.

Parameters
in/out type description
in ps_sensor_kind The set type.
Returns
  • void

SdfSensorDescriptor::setName ( … )

This will set the name of the sensor.

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

SdfSensorDescriptor::setDescription ( … )

This will set the description of the sensor.

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