API Documentation

GpsMessage

The GPS message.

Arbitration key member(s): header.src_guid

GpsMessage::GpsMessage ( )

A default constructor.

GpsMessage::GpsMessage ( … )

A copy constructor.

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

GpsMessage::GpsMessage ( … )

A convenience constructor from a related type.

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

GpsMessage::~GpsMessage ( )

A default destructor.

GpsMessage::print ( … )

This will print internal values.

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

Returns

  • void

GpsMessage::get_ps_gps_msg ( ) const

This will provide convenient access to a related type.

Returns

GpsMessage::operator= ( … )

An assignment operator.

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

static GpsMessage::getName ( )

This will get a message name. It is useful in functions requiring message names, such as getMessageTypeByName.

Returns
  • std::string

GpsMessage::getHeader ( ) const

This will get the PolySync message header.

Returns

GpsMessage::setHeader ( … )

This will set the PolySync message header.

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

GpsMessage::getHeaderType ( ) const

This will get the message type identifier.

Returns

GpsMessage::setHeaderType ( … )

This will set the message type identifier.

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

GpsMessage::getHeaderTimestamp ( ) const

This will get the message timestamp. [microseconds]

Returns

GpsMessage::setHeaderTimestamp ( … )

This will set the message timestamp. [microseconds]

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

GpsMessage::getHeaderSrcGuid ( ) const

This will get the message producer’s GUID.

Returns

GpsMessage::setHeaderSrcGuid ( … )

This will set the message producer’s GUID.

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

GpsMessage::getSensorDescriptor ( ) const

This will get the standard sensor descriptor.

Returns

GpsMessage::setSensorDescriptor ( … )

This will set the standard sensor descriptor.

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

GpsMessage::getSensorDescriptorId ( ) const

This will get the identifier.

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

Returns

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

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

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

GpsMessage::getSensorDescriptorTransform ( ) const

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

Returns

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

GpsMessage::getSensorDescriptorTransformParentId ( ) const

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

Returns

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

GpsMessage::getSensorDescriptorTransformTimestamp ( ) const

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

Returns

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

GpsMessage::getSensorDescriptorTransformStack ( ) const

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

Returns

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

GpsMessage::getTimestamp ( ) const

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

Returns

GpsMessage::setTimestamp ( … )

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

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

GpsMessage::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 invalid.

Returns

GpsMessage::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 invalid.

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

GpsMessage::getNativeTimestampFormat ( ) const

This will get the timestamp format. PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means invalid.

Returns
  • unsigned char

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

GpsMessage::getNativeTimestampValue ( ) const

This will get the timestamp value.

Returns
  • unsigned long long

GpsMessage::setNativeTimestampValue ( … )

This will set the timestamp value.

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

GpsMessage::getHeading ( ) const

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

Returns
  • double

GpsMessage::setHeading ( … )

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

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

GpsMessage::getLatitude ( ) const

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

Returns
  • double

GpsMessage::setLatitude ( … )

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

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

GpsMessage::getLongitude ( ) const

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

Returns
  • double

GpsMessage::setLongitude ( … )

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

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

GpsMessage::getAltitude ( ) const

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

Returns
  • double

GpsMessage::setAltitude ( … )

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

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

GpsMessage::getSpeed ( ) const

This will get the speed over ground. [meters]

Returns
  • double

GpsMessage::setSpeed ( … )

This will set the speed over ground. [meters]

Parameters
in/out type description
in double Speed over ground. [meters]
Returns
  • void

GpsMessage::getSatelliteCount ( ) const

This will get the number of satellites.

Returns
  • unsigned char

GpsMessage::setSatelliteCount ( … )

This will set the number of satellites.

Parameters
in/out type description
in unsigned char Number of satellites.
Returns
  • void

GpsMessage::getFix ( ) const

This will get the fix kind. GPS_FIX_NONE means no fix.

Returns

GpsMessage::setFix ( … )

This will set the fix kind. GPS_FIX_NONE means no fix.

Parameters
in/out type description
in ps_gps_fix_kind Fix kind.