API Documentation

ZonesMessage

The Zone Message Class.

Arbitration key member(s): header.src_guid

ZonesMessage::ZonesMessage ( )

A default constructor.

ZonesMessage::ZonesMessage ( … )

A copy constructor.

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

ZonesMessage::ZonesMessage ( … )

A convenience constructor from a related type.

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

ZonesMessage::~ZonesMessage ( )

A default destructor.

ZonesMessage::print ( … )

This will print internal values.

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

Returns

  • void

ZonesMessage::get_ps_zones_msg ( ) const

This will provide convenient access to a related type.

Returns

ZonesMessage::operator= ( … )

An assignment operator.

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

static ZonesMessage::getName ( )

This will get the message name.

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

Returns
  • std::string

ZonesMessage::getHeader ( ) const

This will get the PolySync message header.

Returns

ZonesMessage::setHeader ( … )

This will set the PolySync message header.

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

ZonesMessage::getHeaderType ( ) const

This will get the message type identifier.

Returns

ZonesMessage::setHeaderType ( … )

This will set the message type identifier.

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

ZonesMessage::getHeaderTimestamp ( ) const

This will get the message timestamp. [microseconds]

Returns

ZonesMessage::setHeaderTimestamp ( … )

This will set the message timestamp. [microseconds]

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

ZonesMessage::getHeaderSrcGuid ( ) const

This will get the message producer’s GUID.

Returns

ZonesMessage::setHeaderSrcGuid ( … )

This will set the message producer’s GUID.

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

ZonesMessage::getSensorDescriptor ( ) const

This will get the standard sensor descriptor.

Returns

ZonesMessage::setSensorDescriptor ( … )

This will set the standard sensor descriptor.

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

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

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

ZonesMessage::getSensorDescriptorType ( ) 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

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

ZonesMessage::getSensorDescriptorTransform ( ) const

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

Returns

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

ZonesMessage::getSensorDescriptorTransformParentId ( ) const

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

Returns

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

ZonesMessage::getSensorDescriptorTransformTimestamp ( ) const

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

Returns

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

ZonesMessage::getSensorDescriptorTransformStack ( ) const

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

Returns

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

ZonesMessage::getTimestamp ( ) const

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

Returns

ZonesMessage::setTimestamp ( … )

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

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

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

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

ZonesMessage::getNativeTimestampFormat ( ) const

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

Returns
  • unsigned char

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

ZonesMessage::getNativeTimestampValue ( ) const

This will get the timestamp value.

Returns
  • unsigned long long

ZonesMessage::setNativeTimestampValue ( … )

This will set the timestamp value.

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

ZonesMessage::getPoints ( ) const

This will get the zones.

Returns

ZonesMessage::setPoints ( … )

This will set the zones.

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