API Documentation

GpsAccuracyMessage

The global positioning system (GPS) accuracy message.

The header.timestamp stores the publish timestamp (updated by the publishing node).

Arbitration key member(s): header.src_guid, sensor_descriptor.id

GpsAccuracyMessage::GpsAccuracyMessage ( )

A default constructor.

GpsAccuracyMessage::GpsAccuracyMessage ( … )

A copy constructor.

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

GpsAccuracyMessage::GpsAccuracyMessage ( … )

This will provide a convenience constructor from a related type.

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

GpsAccuracyMessage::~GpsAccuracyMessage ( )

A default destructor.

GpsAccuracyMessage::print ( … )

This will print internal values.

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

Returns

  • void

GpsAccuracyMessage::get_ps_gps_accuracy_msg ( ) const

This will provide convenient access to a related type.

Returns

GpsAccuracyMessage::operator= ( … )

An assignment operator.

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

static GpsAccuracyMessage::getName ( )

This will get the message name.

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

Returns
  • std::string

GpsAccuracyMessage::getHeader ( ) const

This will get the PolySync message header.

Returns

GpsAccuracyMessage::setHeader ( … )

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

GpsAccuracyMessage::getHeaderType ( ) const

This will get the message type identifier.

Returns

GpsAccuracyMessage::setHeaderType ( … )

This will set the message type identifier.

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

GpsAccuracyMessage::getHeaderTimestamp ( ) const

This will get the message timestamp. [microseconds]

Returns

GpsAccuracyMessage::setHeaderTimestamp ( … )

This will set the message timestamp. [microseconds]

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

GpsAccuracyMessage::getHeaderSrcGuid ( ) const

This will get the message producer’s GUID.

Returns

GpsAccuracyMessage::setHeaderSrcGuid ( … )

This will set the message producer’s GUID.

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

GpsAccuracyMessage::getSensorDescriptor ( ) const

This will get the standard sensor descriptor.

Returns

GpsAccuracyMessage::setSensorDescriptor ( … )

This will set the standard sensor descriptor.

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

GpsAccuracyMessage::getSensorDescriptorId ( ) const

This will get the identifier.

In most cases, this is the serial number. Value PSYNC_SENSOR_ID_INVALID means invalid.

Returns

GpsAccuracyMessage::setSensorDescriptorId ( … )

This will set the identifier.

In most cases, this is the serial number. Value PSYNC_SENSOR_ID_INVALID means invalid.

Parameters
in/out type description
in ps_identifier
Returns
  • void

GpsAccuracyMessage::getSensorDescriptorType ( ) const

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

Returns

GpsAccuracyMessage::setSensorDescriptorType ( … )

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

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

GpsAccuracyMessage::getSensorDescriptorTransform ( ) const

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

Returns

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

GpsAccuracyMessage::getSensorDescriptorTransformParentId ( ) const

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

Returns

GpsAccuracyMessage::setSensorDescriptorTransformParentId ( … )

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

Parameters
in/out type description
in ps_identifier The parent coordinate frame identifier.
Returns
  • void

GpsAccuracyMessage::getSensorDescriptorTransformTimestamp ( ) const

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

Returns

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

GpsAccuracyMessage::getSensorDescriptorTransformStack ( ) const

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

Returns

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

GpsAccuracyMessage::getTimestamp ( ) const

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

Returns

GpsAccuracyMessage::setTimestamp ( … )

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

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

GpsAccuracyMessage::getNativeTimestamp ( ) const

This will get 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 invalid.

Returns

GpsAccuracyMessage::setNativeTimestamp ( … )

This will set 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 invalid.

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

GpsAccuracyMessage::getNativeTimestampFormat ( ) const

This will get the timestamp format. PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means invalid.

Returns
  • unsigned char

GpsAccuracyMessage::setNativeTimestampFormat ( … )

This will set the timestamp format. PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means invalid.

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

GpsAccuracyMessage::getNativeTimestampValue ( ) const

This will get the timestamp value.

Returns
  • unsigned long long

GpsAccuracyMessage::setNativeTimestampValue ( … )

This will set the timestamp value.

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

GpsAccuracyMessage::getHeadingQuality ( ) const

This will get the heading quality. HEADING_QUALITY_NOT_AVAILABLE means no information available.

Returns

GpsAccuracyMessage::setHeadingQuality ( … )

This will set the heading quality. HEADING_QUALITY_NOT_AVAILABLE means no information available.

Parameters
in/out type description
in ps_gps_heading_quality_kind
Returns
  • void

GpsAccuracyMessage::getHeadingSearchType ( ) const

This will get the heading search type. HEADING_SEARCH_NOT_AVAILABLE means no information available.

Returns

GpsAccuracyMessage::setHeadingSearchType ( … )

This will set the heading search type. HEADING_SEARCH_NOT_AVAILABLE means no information available.

Parameters
in/out type description
in ps_gps_heading_search_kind Heading search type.
Returns
  • void

GpsAccuracyMessage::getHdop ( ) const

This will get the horizontal dilution of precision. PSYNC_POSITION_NOT_AVAILABLE means not available.

Returns
  • double

GpsAccuracyMessage::setHdop ( … )

This will set the horizontal dilution of precision. PSYNC_POSITION_NOT_AVAILABLE means not available.

Parameters
in/out type description
in double Horizontal dilution of precision.
Returns
  • void

GpsAccuracyMessage::getVdop ( ) const

This will get the vertical dilution of precision. PSYNC_POSITION_NOT_AVAILABLE means not available.

Returns
  • void

GpsAccuracyMessage::setVdop ( … )

This will set the vertical dilution of precision. PSYNC_POSITION_NOT_AVAILABLE means not available.

Parameters
in/out type description
in double Vertical dilution of precision.
Returns
  • void

GpsAccuracyMessage::getPdop ( ) const

This will get the positional dilution of precision. PSYNC_POSITION_NOT_AVAILABLE means not available.

Returns
  • void

GpsAccuracyMessage::setPdop ( … )

This will set the positional dilution of precision. PSYNC_POSITION_NOT_AVAILABLE means not available.

Parameters
in/out type description
in double Positional dilution of precision.
Returns
  • void

GpsAccuracyMessage::getUndulation ( ) const

This will get the difference between altitude and WGS-84 ellipsoidal altitude. [meters] PSYNC_ALTITUDE_NOT_AVAILABLE means not available.

Returns
  • double

GpsAccuracyMessage::setUndulation ( … )

This will set the difference between altitude and WGS-84 ellipsoidal altitude. [meters] PSYNC_ALTITUDE_NOT_AVAILABLE means not available.

Parameters
in/out type description
in double Difference between altitude and WGS-84 ellipsoidal altitude.
Returns
  • void

GpsAccuracyMessage::getEnuPositionAccuracy ( ) const

This will get the East-North-Up position accuracy. [ENU meters] PSYNC_POSITION_NOT_AVAILABLE means not available.

Returns
  • std::array< double, 3 >

GpsAccuracyMessage::setEnuPositionAccuracy ( … )

This will set the East-North-Up position accuracy. [ENU meters] PSYNC_POSITION_NOT_AVAILABLE means not available.

Parameters
in/out type description
in std::array< double, 3 > & East-North-Up position accuracy.
Returns
  • void

GpsAccuracyMessage::getEnuVelocityAccuracy ( ) const

This will get the East-North-Up velocity accuracy. [ENU meters] PSYNC_POSITION_NOT_AVAILABLE means not available.

Returns
  • std::array< double, 3 >

GpsAccuracyMessage::setEnuVelocityAccuracy ( … )

This will set the East-North-Up velocity accuracy. [ENU meters] PSYNC_POSITION_NOT_AVAILABLE means not available.

Parameters
in/out type description
in std::array< double, 3 > & East-North-Up velocity accuracy.
Returns
  • void

GpsAccuracyMessage::getHeadingAccuracy ( ) const

This will get the heading (yaw) angle accuracy. [radians] PSYNC_ORIENTATION_NOT_AVAILABLE means not available.

Returns
  • double

GpsAccuracyMessage::setHeadingAccuracy ( … )

This will set the heading (yaw) angle accuracy. [radians] PSYNC_ORIENTATION_NOT_AVAILABLE means not available.

Parameters
in/out type description
in double Heading (yaw) angle accuracy. [radians]
Returns
  • void