API Documentation

PlatformMotionMessage

A platform motion message.

Arbitration key member(s): header.src_guid

PlatformMotionMessage::PlatformMotionMessage ( )

A default constructor.

PlatformMotionMessage::PlatformMotionMessage ( … )

A copy constructor.

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

PlatformMotionMessage::PlatformMotionMessage ( … )

A convenience constructor from a related type.

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

PlatformMotionMessage::~PlatformMotionMessage ( )

A default destructor.

PlatformMotionMessage::print ( … )

This will print internal values.

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

Returns

  • void

PlatformMotionMessage::get_ps_platform_motion_msg ( ) const

This will provide convenient access to a related type.

Returns

PlatformMotionMessage::operator= ( … )

An assignment operator.

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

static PlatformMotionMessage::getName ( )

This will get a message name.

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

Returns
  • std::string

PlatformMotionMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

PlatformMotionMessage::setHeader ( … )

This will set a PolySync message header.

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

PlatformMotionMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

PlatformMotionMessage::setHeaderType ( … )

This will set a message type identifier.

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

PlatformMotionMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

PlatformMotionMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

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

PlatformMotionMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

PlatformMotionMessage::setHeaderSrcGuid ( … )

Thsi will set a message producer’s GUID.

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

PlatformMotionMessage::getSensorDescriptor ( ) const

This will get a standard sensor descriptor.

Returns

PlatformMotionMessage::setSensorDescriptor ( … )

This will set a standard sensor descriptor.

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

PlatformMotionMessage::getSensorDescriptorId ( ) const

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

Returns

PlatformMotionMessage::setSensorDescriptorId ( … )

This will set an 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

PlatformMotionMessage::getSensorDescriptorType ( ) const

Thsi 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

PlatformMotionMessage::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

PlatformMotionMessage::getSensorDescriptorTransform ( ) const

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

Returns

PlatformMotionMessage::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

PlatformMotionMessage::getSensorDescriptorTransformParentId ( ) const

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

Returns

PlatformMotionMessage::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

PlatformMotionMessage::getSensorDescriptorTransformTimestamp ( ) const

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

Returns

PlatformMotionMessage::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

PlatformMotionMessage::getSensorDescriptorTransformStack ( ) const

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

Returns

PlatformMotionMessage::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

PlatformMotionMessage::getTimestamp ( ) const

This will get the last updated timestamp. [UTC microseconds]

Returns

PlatformMotionMessage::setTimestamp ( … )

This will set the last updated timestamp. [UTC microseconds]

Parameters
in/out type description
in ps_timestamp The last update timestamp.
Returns
  • void

PlatformMotionMessage::getNativeTimestamp ( ) const

This will get the native timestamp associated with the last update. This is provided by some devices. Please check the format field for meaning. Format value PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means it is invalid.

Returns

PlatformMotionMessage::setNativeTimestamp ( … )

This will set the native timestamp associated with the last update. This is provided by some devices. Please check the format field for meaning. Format value PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means it is invalid.

Parameters
in/out type description
in NativeTimestamp &
Returns
  • void

PlatformMotionMessage::getNativeTimestampFormat ( ) const

This will get the timestamp format. PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means it is invalid.

Returns
  • unsigned char

PlatformMotionMessage::setNativeTimestampFormat ( … )

This will set the timestamp format. PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means it is invalid.

Parameters
in/out type description
in unsigned char Timestamp format.
Returns
  • void

PlatformMotionMessage::getNativeTimestampValue ( ) const

This will get the timestamp value.

Returns
  • unsigned long long

PlatformMotionMessage::setNativeTimestampValue ( … )

This will set the timestamp value.

Parameters
in/out type description
in unsigned long long Timestamp value.
Returns
  • void

PlatformMotionMessage::getPosition ( ) const

This will get the position. [xyz meters] PSYNC_POSITION_NOT_AVAILABLE means the given axis component is not available.

Returns
  • std::array< double, 3 >

PlatformMotionMessage::setPosition ( … )

This will set the position.

Parameters
in/out type description
in std::array< double, 3 > & Position. [xyz meters]
Returns
  • void

PlatformMotionMessage::getOrientation ( ) const

This will get the orientation quaternion. [xyzw quaternion] PSYNC_ORIENTATION_NOT_AVAILABLE means the given axis component is not available.

Returns
  • std::array< double, 4 >

PlatformMotionMessage::setOrientation ( … )

This will set the orientation quaternion. [xyzw quaternion] PSYNC_ORIENTATION_NOT_AVAILABLE means the given axis component is not available.

Parameters
in/out type description
in const std::array< double, 4 > & Orientation quaternion. [xyzw quaternion]
Returns
  • void

PlatformMotionMessage::getRotationRate ( ) const

This will get the rotation rate. [xyz radians/second] PSYNC_ROTATION_RATE_NOT_AVAILABLE means the given axis component is not available.

Returns
  • std::array< double, 3 >

PlatformMotionMessage::setRotationRate ( … )

Thsi will set the rotation rate. [xyz radians/second] PSYNC_ROTATION_RATE_NOT_AVAILABLE means the given axis component is not available.

Parameters
in/out type description
in const std::array< double, 3 > & Rotation rate. [xyz radians/second]
Returns
  • void

PlatformMotionMessage::getVelocity ( ) const

This will get the velocity. [xyz meters/second] PSYNC_VELOCITY_NOT_AVAILABLE means the given axis component is not available.

Returns
  • std::array< double, 3 >

PlatformMotionMessage::setVelocity ( … )

Thsi will set the velocity. [xyz meters/second] PSYNC_VELOCITY_NOT_AVAILABLE means the given axis component is not available.

Parameters
in/out type description
in const std::array< double, 3 > & Velocity. [xyz meters/second]
Returns
  • void

PlatformMotionMessage::getAcceleration ( ) const

This will get the velocity. [xyz meters/second^2] PSYNC_ACCELERATION_NOT_AVAILABLE means the given axis component is not available.

Returns
  • std::array< double, 3 >

PlatformMotionMessage::setAcceleration ( … )

This will set the velocity. [xyz meters/second^2] PSYNC_ACCELERATION_NOT_AVAILABLE means the given axis component is not available.

Parameters
in/out type description
in const std::array< double, 3 > & Acceleration. [xyz meters/second^2]
Returns
  • void

PlatformMotionMessage::getHeading ( ) const

This will get the heading angle. Zero radians equals North. [radians] PSYNC_HEADING_NOT_AVAILABLE means it is not available.

Returns
  • double

PlatformMotionMessage::setHeading ( … )

This will set the heading angle. Zero radians equals North. [radians] PSYNC_HEADING_NOT_AVAILABLE means it is not available.

Parameters
in/out type description
in double Heading angle. Zero radians equals North. [radians]
Returns
  • void

PlatformMotionMessage::getLatitude ( ) const

This will get the latitude. [radians] PSYNC_LATITUDE_NOT_AVAILABLE means it is not available.

Returns
  • double

PlatformMotionMessage::setLatitude ( … )

This will set the latitude. [radians] PSYNC_LATITUDE_NOT_AVAILABLE means it is not available.

Parameters
in/out type description
in double Latitude. [radians]
Returns
  • void

PlatformMotionMessage::getLongitude ( ) const

This will get the longitude. [radians] PSYNC_LONGITUDE_NOT_AVAILABLE means it is not available.

Returns
  • double

PlatformMotionMessage::setLongitude ( … )

This will set the longitude. [radians] PSYNC_LONGITUDE_NOT_AVAILABLE means it is not available.

Parameters
in/out type description
in double Longitude. [radians]
Returns
  • void

PlatformMotionMessage::getAltitude ( ) const

This will get the altitude. [meters] PSYNC_ALTITUDE_NOT_AVAILABLE means it is not available.

Returns
  • double

PlatformMotionMessage::setAltitude ( … )

This will set the altitude. [meters] PSYNC_ALTITUDE_NOT_AVAILABLE means it is not available.

Parameters
in/out type description
in double Altitude. [meters]
Returns
  • void