API Documentation

SensorDescriptor

This identifies a sensor and describes its coordinate frame.

SensorDescriptor::SensorDescriptor ( )

A default constructor.

SensorDescriptor::SensorDescriptor ( … )

A copy constructor.

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

SensorDescriptor::SensorDescriptor ( … )

A convenience constructor from a related type.

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

SensorDescriptor::~SensorDescriptor ( )

A default destructor.

SensorDescriptor::print ( … )

This will print internal values.

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

Returns

  • void

SensorDescriptor::get_ps_sensor_descriptor ( ) const

This will provide convenient access to a related type.

Returns

SensorDescriptor::operator= ( … )

An assignment operator.

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

SensorDescriptor::getId ( ) const

This will get the sensor descriptor ID. In most cases, this is the serial number. Value PSYNC_SENSOR_ID_INVALID means it is invalid.

Returns

SensorDescriptor::setId ( … )

This will set the sensor descriptor ID. In most cases this is the serial number. Value PSYNC_SENSOR_ID_INVALID means it is invalid.

Parameters
in/out type description
in ps_identifier ID to set.
Returns
  • void

SensorDescriptor::getType ( ) const

This will get the sensor descriptor type. Value PSYNC_SENSOR_KIND_INVALID means it is invalid. Value PSYNC_SENSOR_KIND_NOT_AVAILABLE means the type is not available.

Returns

SensorDescriptor::setType ( … )

This will set the sensor descriptor type. Value PSYNC_SENSOR_KIND_INVALID means it is invalid. Value PSYNC_SENSOR_KIND_NOT_AVAILABLE means the type is not available.

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

SensorDescriptor::getTransform ( ) const

This will get the transform that describes this data’s coordinate frame.

Returns

SensorDescriptor::setTransform ( … )

This will set the transform that describes this data’s coordinate frame.

Parameters
in/out type description
in TransformStack & Transform to set.
Returns
  • void

SensorDescriptor::getTransformParentId ( ) const

This will get the parent coordinate frame identifier. Value PSYNC_COORDINATE_FRAME_INVALID means it is invalid.

Returns

SensorDescriptor::setTransformParentId ( … )

This will set the parent coordinate frame identifier. Value PSYNC_COORDINATE_FRAME_INVALID means it is invalid.

Parameters
in/out type description
in ps_identifier Transform parent ID to set.
Returns
  • void

SensorDescriptor::getTransformTimestamp ( ) const

This will get the last updated timestamp of the parent and/or any of its children transformations.

Returns

SensorDescriptor::setTransformTimestamp ( … )

This will set the last updated timestamp of the parent and/or any of its children transformations.

Parameters
in/out type description
in ps_timestamp Transform timestamp to set.
Returns
  • void

SensorDescriptor::getTransformStack ( ) const

This will get the transformation stack that describes a PolySync transformation.

Returns

SensorDescriptor::setTransformStack ( … ) const

This will set the transformation stack that describes a PolySync transformation.

Parameters
in/out type description
in std::vector<TransformDescriptor> & Transform stack to set.
Returns