API Documentation

ObjectsMessage

An object’s message.

Arbitration key member(s): header.src_guid

ObjectsMessage::ObjectsMessage ( )

A default constructor.

ObjectsMessage::ObjectsMessage ( … )

A copy constructor.

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

ObjectsMessage::ObjectsMessage ( … )

A convenience constructor from a related type.

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

ObjectsMessage::~ObjectsMessage ( )

A default destructor.

ObjectsMessage::print ( … )

This will print internal values.

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

Returns

  • void

ObjectsMessage::get_ps_objects_msg ( ) const

This will provide convenient access to a related type.

Returns

ObjectsMessage::operator= ( … )

An assignment operator.

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

static ObjectsMessage::getName ( )

This will get a message name.

It is useful in functions requiring message names, such as getMessageTypeByName.

Returns
  • std::string

ObjectsMessage::getHeader ( ) const

This will get the PolySync message header.

Returns

ObjectsMessage::setHeader ( … )

This will set the PolySync message header.

Parameters
in/out type description
in MsgHeader & Message header.
Returns
  • void

ObjectsMessage::getHeaderType ( ) const

This will get the message type identifier.

Returns

ObjectsMessage::setHeaderType ( … )

This will set the message type identifier.

Parameters
in/out type description
in ps_msg_type Message type identifier.
Returns
  • void

ObjectsMessage::getHeaderTimestamp ( ) const

This will get the message timestamp. [microseconds]

Returns

ObjectsMessage::setHeaderTimestamp ( … )

This will set the message timestamp. [microseconds]

Parameters
in/out type description
in ps_timestamp In microseconds.
Returns
  • void

ObjectsMessage::getHeaderSrcGuid ( ) const

This will get the message producer’s GUID.

Returns

ObjectsMessage::setHeaderSrcGuid ( … )

This will set the message producer’s GUID.

Parameters
in/out type description
in ps_guid Message producer’s GUID.
Returns
  • void

ObjectsMessage::getSensorDescriptor ( ) const

This will get the standard sensor descriptor.

Returns

ObjectsMessage::setSensorDescriptor ( … )

This will set the standard sensor descriptor.

Parameters
in/out type description
in SensorDescriptor & Standard sensor descriptor.
Returns
  • void

ObjectsMessage::getSensorDescriptorId ( ) const

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

Returns

ObjectsMessage::setSensorDescriptorId ( … )

This will set the identifier. 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
Returns
  • void

ObjectsMessage::getSensorDescriptorType ( ) const

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

Returns

ObjectsMessage::setSensorDescriptorType ( … )

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 The sensor descriptor type.
Returns
  • void

ObjectsMessage::getSensorDescriptorTransform ( ) const

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

Returns

ObjectsMessage::setSensorDescriptorTransform ( … )

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

Parameters
in/out type description
in TransformStack & The transform that describes this data’s coordinate frame.
Returns
  • void

ObjectsMessage::getSensorDescriptorTransformParentId ( ) const

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

Returns

ObjectsMessage::setSensorDescriptorTransformParentId ( … )

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 The parent coordinate frame identifier.
Returns
  • void

ObjectsMessage::getSensorDescriptorTransformTimestamp ( ) const

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

Returns

ObjectsMessage::setSensorDescriptorTransformTimestamp ( … )

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 The last update timestamp of the transform.
Returns
  • void

ObjectsMessage::getSensorDescriptorTransformStack ( ) const

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

Returns

ObjectsMessage::setSensorDescriptorTransformStack ( … )

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

Parameters
in/out type description
in std::vector<TransformDescriptor> & The transformation stack.
Returns
  • void

ObjectsMessage::getObjects ( ) const

This will get objects.

Returns

ObjectsMessage::setObjects ( … )

This will set objects.

Parameters
in/out type description
in const std::vector< Object > & Objects.
Returns
  • void