API Documentation
ImageDataMessage
The image data message.
Arbitration key member(s): header.src_guid
ImageDataMessage::ImageDataMessage ( )
A default constructor.
ImageDataMessage::ImageDataMessage ( … )
A copy constructor.
Parameters
in/out | type | description |
---|---|---|
in | const ImageDataMessage & | Instance being copied. |
ImageDataMessage::ImageDataMessage ( … )
A convenience constructor from a related type.
Parameters
in/out | type | description |
---|---|---|
in | const ps_image_data_msg & | Instance of related type. |
ImageDataMessage::~ImageDataMessage ( )
A default destructor.
ImageDataMessage::print ( … )
This will print internal values.
Parameters
in/out | type | description |
---|---|---|
in | std::ostream & | Output stream that defaults to std::cout. |
Returns
- void
ImageDataMessage::get_ps_image_data_msg ( ) const
The convenient access of a related type.
Returns
- const ps_image_data_msg *
ImageDataMessage::operator= ( … )
An assignment operator.
Parameters
in/out | type | description |
---|---|---|
in | const ImageDataMessage & | Instance to copy. |
Returns
static ImageDataMessage::getName ( )
This will get the message name.
It is useful in functions requiring message names, such as getMessageTypeByName.
Returns
- std::string
ImageDataMessage::getHeader ( ) const
This will get the PolySync message header.
Returns
ImageDataMessage::setHeader ( … )
This will set the PolySync message header.
Parameters
in/out | type | description |
---|---|---|
in | MsgHeader & | Message header. |
Returns
- void
ImageDataMessage::getHeaderType ( ) const
This will get the message type identifier.
Returns
ImageDataMessage::setHeaderType ( … )
This will set the message type identifier.
Parameters
in/out | type | description |
---|---|---|
in | ps_msg_type | Message type identifier. |
Returns
- void
ImageDataMessage::getHeaderTimestamp ( ) const
This will get the message timestamp. [microseconds]
Returns
ImageDataMessage::setHeaderTimestamp ( … )
This will set the message timestamp. [microseconds]
Parameters
in/out | type | description |
---|---|---|
in | ps_timestamp | In microseconds. |
Returns
- void
ImageDataMessage::getHeaderSrcGuid ( ) const
This will get the message producer’s GUID.
Returns
ImageDataMessage::setHeaderSrcGuid ( … )
This will set the message producer’s GUID.
Parameters
in/out | type | description |
---|---|---|
in | ps_guid | Message producer’s GUID. |
Returns
- void
ImageDataMessage::getSensorDescriptor ( ) const
This will get the standard sensor descriptor.
Returns
ImageDataMessage::setSensorDescriptor ( … )
This will set the standard sensor descriptor.
Parameters
in/out | type | description |
---|---|---|
in | SensorDescriptor & | Standard sensor descriptor. |
Returns
- void
ImageDataMessage::getSensorDescriptorId ( ) const
This will get the identifier.
In most cases, this is the serial number. Value PSYNC_SENSOR_ID_INVALID means invalid.
Returns
ImageDataMessage::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
ImageDataMessage::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
ImageDataMessage::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
ImageDataMessage::getSensorDescriptorTransform ( ) const
This will get the transform that describes this data’s coordinate frame.
Returns
ImageDataMessage::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
ImageDataMessage::getSensorDescriptorTransformParentId ( ) const
This will get the parent coordinate frame identifier. Value PSYNC_COORDINATE_FRAME_INVALID means invalid.
Returns
ImageDataMessage::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
ImageDataMessage::getSensorDescriptorTransformTimestamp ( ) const
This will get the last updated timestamp of the parent, and/or any of its children transformations.
Returns
ImageDataMessage::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
ImageDataMessage::getSensorDescriptorTransformStack ( ) const
This will get the transformation stack that describes a PolySync transformation.
Returns
- std::vector<TransformDescriptor>
ImageDataMessage::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
ImageDataMessage::getTimestamp ( ) const
This will get the last updated timestamp. [UTC microseconds]
Returns
ImageDataMessage::setTimestamp ( … )
This will set the last updated timestamp. [UTC microseconds]
Parameters
in/out | type | description |
---|---|---|
in | ps_timestamp | The last update timestamp. |
Returns
- void
ImageDataMessage::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
ImageDataMessage::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
ImageDataMessage::getNativeTimestampFormat ( ) const
This will get the timestamp format. PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID means invalid.
Returns
- unsigned char
ImageDataMessage::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
ImageDataMessage::getNativeTimestampValue ( ) const
This will get the timestamp value.
Returns
- unsigned long long
ImageDataMessage::setNativeTimestampValue ( … )
This will set the timestamp value.
Parameters
in/out | type | description |
---|---|---|
in | unsigned long long | Timestamp value. |
Returns
- void
ImageDataMessage::getPixelFormat ( ) const
This will get the image data format.
Returns
ImageDataMessage::setPixelFormat ( … )
This will set the image data format.
Parameters
in/out | type | description |
---|---|---|
in | ps_pixel_format_kind | Image data format. |
Returns
- void
ImageDataMessage::getFrameId ( ) const
The image counter. PSYNC_IDENTIFIER_INVALID means not available.
Returns
ImageDataMessage::setFrameId ( … )
The image counter. PSYNC_IDENTIFIER_INVALID means not available.
Parameters
in/out | type | description |
---|---|---|
in | ps_identifier | Image counter. |
Returns
- void
ImageDataMessage::getWidth ( ) const
This will get the image width. [pixels]
Returns
- void
ImageDataMessage::setWidth ( … )
This will set the image width. [pixels]
Parameters
in/out | type | description |
---|---|---|
in | Image width. [pixels] |
Returns
- void
ImageDataMessage::getHeight ( ) const
This will get the image height. [pixels]
Returns
- void
ImageDataMessage::setHeight ( … )
This will set the image height. [pixels]
Parameters
in/out | type | description |
---|---|---|
in | Image height. [pixels] |
Returns
- void
ImageDataMessage::getDataBuffer ( ) const
This will get the image data buffer.
Returns
- std::vector< unsigned char >
ImageDataMessage::setDataBuffer ( … )
This will set the image data buffer.
Parameters
in/out | type | description |
---|---|---|
in | std::vector< unsigned char > | Image data buffer. |
Returns
- void