The chunk data which contains additional information about an image. More...

#include <ChunkData.h>

Inheritance diagram for ChunkData:

Public Member Functions
	ChunkData ()

	ChunkData (const ChunkData &src)

virtual	~ChunkData (void)

void	SetChunks (GenApi::INodeMap &pNodeMap)

float64_t	GetBlackLevel () const
	Description: Returns the black level used to capture the image.

int64_t	GetFrameID () const
	Description: Returns the image frame ID.

int64_t	GetLineStatusAll () const
	Description: Returns the status of all the I/O lines at the start of exposure event.

uint8_t *	GetSerialData () const
	Description: Returns the serial data that was received.

int64_t	GetCurrentDatarate () const
	Description: Visibility:

float64_t	GetExposureTime () const
	Description: Returns the exposure time used to capture the image.

bool	GetSerialReceiveOverflow () const
	Description: Returns the status of the chunk serial receive overflow.

int64_t	GetTimestamp () const
	Description: Returns the Timestamp of the image.

bool	GetModeActive () const
	Description: Activates the inclusion of Chunk data in the payload of the image.

int64_t	GetExposureEndLineStatusAll () const
	Description: Returns the status of all the I/O lines at the end of exposure event.

int64_t	GetWidth () const
	Description: Returns the width of the image included in the payload.

int64_t	GetImage () const
	Description: Returns the image payload.

int64_t	GetHeight () const
	Description: Returns the height of the image included in the payload.

float64_t	GetGain () const
	Description: Returns the gain used to capture the image.

int64_t	GetSequencerSetActive () const
	Description: Returns the index of the active set of the running sequencer included in the payload.

float64_t	GetCompressionRatio () const
	Description: Visibility:

int64_t	GetCRC () const
	Description: Returns the CRC of the image payload.

int64_t	GetOffsetX () const
	Description: Returns the Offset X of the image included in the payload.

int64_t	GetOffsetY () const
	Description: Returns the Offset Y of the image included in the payload.

bool	GetEnable () const
	Description: Enables the inclusion of the selected Chunk data in the payload of the image.

int64_t	GetCompressionMode () const
	Description: Visibility:

int64_t	GetSerialDataLength () const
	Description: Returns the length of the received serial data that was included in the payload.

int64_t	GetPartSelector () const
	Description: Selects the part to access in chunk data in a multipart transmission.

int64_t	GetPixelDynamicRangeMin () const
	Description: Returns the minimum value of dynamic range of the image included in the payload.

int64_t	GetPixelDynamicRangeMax () const
	Description: Returns the maximum value of dynamic range of the image included in the payload.

int64_t	GetTimestampLatchValue () const
	Description: Returns the last Timestamp latched with the TimestampLatch command.

int64_t	GetCounterValue () const
	Description: Returns the value of the selected Chunk counter at the time of the FrameStart event.

float64_t	GetTimerValue () const
	Description: Returns the value of the selected Timer at the time of the FrameStart internal event.

int64_t	GetScanLineSelector () const
	Description: Index for vector representation of one chunk value per line in an image.

int64_t	GetEncoderValue () const
	Description: Returns the counter's value of the selected Encoder at the time of the FrameStart in area scan mode or the counter's value at the time of the LineStart selected by ChunkScanLineSelector in LineScan mode.

int64_t	GetLinePitch () const
	Description: Returns the LinePitch of the image included in the payload.

int64_t	GetTransferBlockID () const
	Description: Returns the unique identifier of the transfer block used to transport the payload.

int64_t	GetTransferQueueCurrentBlockCount () const
	Description: Returns the current number of blocks in the transfer queue.

int64_t	GetStreamChannelID () const
	Description: Returns identifier of the stream channel used to carry the block.

float64_t	GetScan3dCoordinateScale () const
	Description: Returns the Scale for the selected coordinate axis of the image included in the payload.

float64_t	GetScan3dCoordinateOffset () const
	Description: Returns the Offset for the selected coordinate axis of the image included in the payload.

bool	GetScan3dInvalidDataFlag () const
	Description: Returns if a specific non-valid data flag is used in the data stream.

float64_t	GetScan3dInvalidDataValue () const
	Description: Returns the Invalid Data Value used for the image included in the payload.

float64_t	GetScan3dAxisMin () const
	Description: Returns the Minimum Axis value for the selected coordinate axis of the image included in the payload.

float64_t	GetScan3dAxisMax () const
	Description: Returns the Maximum Axis value for the selected coordinate axis of the image included in the payload.

float64_t	GetScan3dTransformValue () const
	Description: Returns the transform value.

float64_t	GetScan3dCoordinateReferenceValue () const
	Description: Reads the value of a position or pose coordinate for the anchor or transformed coordinate systems relative to the reference point.

int64_t	GetInferenceFrameId () const
	Description: Returns the frame ID associated with the most recent inference result.

int64_t	GetInferenceResult () const
	Description: Returns the chunk data inference result.

float64_t	GetInferenceConfidence () const
	Description: Returns the chunk data inference confidence percentage.

InferenceBoundingBoxResult	GetInferenceBoundingBoxResult () const
	Description: Returns the chunk inference bounding box result data.

Public Member Functions inherited from IChunkData
virtual	~IChunkData ()

virtual void	SetChunks (GenApi::INodeMap &pNodeMap)=0

virtual float64_t	GetBlackLevel () const =0

virtual int64_t	GetFrameID () const =0

virtual int64_t	GetLineStatusAll () const =0

virtual uint8_t *	GetSerialData () const =0

virtual int64_t	GetCurrentDatarate () const =0

virtual float64_t	GetExposureTime () const =0

virtual bool	GetSerialReceiveOverflow () const =0

virtual int64_t	GetTimestamp () const =0

virtual bool	GetModeActive () const =0

virtual int64_t	GetExposureEndLineStatusAll () const =0

virtual int64_t	GetWidth () const =0

virtual int64_t	GetImage () const =0

virtual int64_t	GetHeight () const =0

virtual float64_t	GetGain () const =0

virtual int64_t	GetSequencerSetActive () const =0

virtual float64_t	GetCompressionRatio () const =0

virtual int64_t	GetCRC () const =0

virtual int64_t	GetOffsetX () const =0

virtual int64_t	GetOffsetY () const =0

virtual bool	GetEnable () const =0

virtual int64_t	GetCompressionMode () const =0

virtual int64_t	GetSerialDataLength () const =0

virtual int64_t	GetPartSelector () const =0

virtual int64_t	GetPixelDynamicRangeMin () const =0

virtual int64_t	GetPixelDynamicRangeMax () const =0

virtual int64_t	GetTimestampLatchValue () const =0

virtual int64_t	GetCounterValue () const =0

virtual float64_t	GetTimerValue () const =0

virtual int64_t	GetScanLineSelector () const =0

virtual int64_t	GetEncoderValue () const =0

virtual int64_t	GetLinePitch () const =0

virtual int64_t	GetTransferBlockID () const =0

virtual int64_t	GetTransferQueueCurrentBlockCount () const =0

virtual int64_t	GetStreamChannelID () const =0

virtual float64_t	GetScan3dCoordinateScale () const =0

virtual float64_t	GetScan3dCoordinateOffset () const =0

virtual bool	GetScan3dInvalidDataFlag () const =0

virtual float64_t	GetScan3dInvalidDataValue () const =0

virtual float64_t	GetScan3dAxisMin () const =0

virtual float64_t	GetScan3dAxisMax () const =0

virtual float64_t	GetScan3dTransformValue () const =0

virtual float64_t	GetScan3dCoordinateReferenceValue () const =0

virtual int64_t	GetInferenceFrameId () const =0

virtual int64_t	GetInferenceResult () const =0

virtual float64_t	GetInferenceConfidence () const =0

virtual InferenceBoundingBoxResult	GetInferenceBoundingBoxResult () const =0

Friends
class	ChunkDataImpl

Additional Inherited Members
Protected Member Functions inherited from IChunkData
	IChunkData ()

Protected Attributes inherited from IChunkData
ChunkDataData *	m_pChunkDataData

Detailed Description

The chunk data which contains additional information about an image.

Examples: Compression.cpp, and Inference.cpp.

Constructor & Destructor Documentation

◆ ChunkData() [1/2]

ChunkData ( )

◆ ChunkData() [2/2]

ChunkData ( const ChunkData & src )

◆ ~ChunkData()

virtual ~ChunkData ( void )

virtual

Member Function Documentation

◆ GetBlackLevel()

float64_t GetBlackLevel ( ) const

virtual

Description: Returns the black level used to capture the image.

Visibility:

Implements IChunkData.

◆ GetCompressionMode()

int64_t GetCompressionMode ( ) const

virtual

Description: Visibility:

Implements IChunkData.

◆ GetCompressionRatio()

float64_t GetCompressionRatio ( ) const

virtual

Description: Visibility:

Implements IChunkData.

Examples: Compression.cpp.

◆ GetCounterValue()

int64_t GetCounterValue ( ) const

virtual

Description: Returns the value of the selected Chunk counter at the time of the FrameStart event.

Visibility: Expert

Implements IChunkData.

◆ GetCRC()

int64_t GetCRC ( ) const

virtual

Description: Returns the CRC of the image payload.

Visibility:

Implements IChunkData.

Examples: Compression.cpp.

◆ GetCurrentDatarate()

int64_t GetCurrentDatarate ( ) const

virtual

Description: Visibility:

Implements IChunkData.

◆ GetEnable()

bool GetEnable ( ) const

virtual

Description: Enables the inclusion of the selected Chunk data in the payload of the image.

Visibility:

Implements IChunkData.

◆ GetEncoderValue()

int64_t GetEncoderValue ( ) const

virtual

Description: Returns the counter's value of the selected Encoder at the time of the FrameStart in area scan mode or the counter's value at the time of the LineStart selected by ChunkScanLineSelector in LineScan mode.

Visibility: Expert

Implements IChunkData.

◆ GetExposureEndLineStatusAll()

int64_t GetExposureEndLineStatusAll ( ) const

virtual

Description: Returns the status of all the I/O lines at the end of exposure event.

Visibility:

Implements IChunkData.

◆ GetExposureTime()

float64_t GetExposureTime ( ) const

virtual

Description: Returns the exposure time used to capture the image.

Visibility:

Implements IChunkData.

◆ GetFrameID()

int64_t GetFrameID ( ) const

virtual

Description: Returns the image frame ID.

Visibility:

Implements IChunkData.

◆ GetGain()

float64_t GetGain ( ) const

virtual

Description: Returns the gain used to capture the image.

Visibility:

Implements IChunkData.

◆ GetHeight()

int64_t GetHeight ( ) const

virtual

Description: Returns the height of the image included in the payload.

Visibility:

Implements IChunkData.

◆ GetImage()

int64_t GetImage ( ) const

virtual

Description: Returns the image payload.

Visibility:

Implements IChunkData.

◆ GetInferenceBoundingBoxResult()

InferenceBoundingBoxResult GetInferenceBoundingBoxResult ( ) const

virtual

Description: Returns the chunk inference bounding box result data.

Visibility: Expert

Implements IChunkData.

Examples: Inference.cpp.

◆ GetInferenceConfidence()

float64_t GetInferenceConfidence ( ) const

virtual

Description: Returns the chunk data inference confidence percentage.

Visibility: Expert

Implements IChunkData.

Examples: Inference.cpp.

◆ GetInferenceFrameId()

int64_t GetInferenceFrameId ( ) const

virtual

Description: Returns the frame ID associated with the most recent inference result.

Visibility: Expert

Implements IChunkData.

Examples: Inference.cpp.

◆ GetInferenceResult()

int64_t GetInferenceResult ( ) const

virtual

Description: Returns the chunk data inference result.

Visibility: Expert

Implements IChunkData.

Examples: Inference.cpp.

◆ GetLinePitch()

int64_t GetLinePitch ( ) const

virtual

Description: Returns the LinePitch of the image included in the payload.

Visibility: Expert

Implements IChunkData.

◆ GetLineStatusAll()

int64_t GetLineStatusAll ( ) const

virtual

Description: Returns the status of all the I/O lines at the start of exposure event.

Visibility:

Implements IChunkData.

◆ GetModeActive()

bool GetModeActive ( ) const

virtual

Description: Activates the inclusion of Chunk data in the payload of the image.

Visibility:

Implements IChunkData.

◆ GetOffsetX()

int64_t GetOffsetX ( ) const

virtual

Description: Returns the Offset X of the image included in the payload.

Visibility:

Implements IChunkData.

◆ GetOffsetY()

int64_t GetOffsetY ( ) const

virtual

Description: Returns the Offset Y of the image included in the payload.

Visibility:

Implements IChunkData.

◆ GetPartSelector()

int64_t GetPartSelector ( ) const

virtual

Description: Selects the part to access in chunk data in a multipart transmission.

Visibility: Expert

Implements IChunkData.

◆ GetPixelDynamicRangeMax()

int64_t GetPixelDynamicRangeMax ( ) const

virtual

Description: Returns the maximum value of dynamic range of the image included in the payload.

Visibility: Expert

Implements IChunkData.

◆ GetPixelDynamicRangeMin()

int64_t GetPixelDynamicRangeMin ( ) const

virtual

Description: Returns the minimum value of dynamic range of the image included in the payload.

Visibility: Expert

Implements IChunkData.

◆ GetScan3dAxisMax()

float64_t GetScan3dAxisMax ( ) const

virtual

Description: Returns the Maximum Axis value for the selected coordinate axis of the image included in the payload.

Visibility: Expert

Implements IChunkData.

◆ GetScan3dAxisMin()

float64_t GetScan3dAxisMin ( ) const

virtual

Description: Returns the Minimum Axis value for the selected coordinate axis of the image included in the payload.

Visibility: Expert

Implements IChunkData.

◆ GetScan3dCoordinateOffset()

float64_t GetScan3dCoordinateOffset ( ) const

virtual

Description: Returns the Offset for the selected coordinate axis of the image included in the payload.

Visibility: Expert

Implements IChunkData.

◆ GetScan3dCoordinateReferenceValue()

float64_t GetScan3dCoordinateReferenceValue ( ) const

virtual

Description: Reads the value of a position or pose coordinate for the anchor or transformed coordinate systems relative to the reference point.

Visibility: Expert

Implements IChunkData.

◆ GetScan3dCoordinateScale()

float64_t GetScan3dCoordinateScale ( ) const

virtual

Description: Returns the Scale for the selected coordinate axis of the image included in the payload.

Visibility: Expert

Implements IChunkData.

◆ GetScan3dInvalidDataFlag()

bool GetScan3dInvalidDataFlag ( ) const

virtual

Description: Returns if a specific non-valid data flag is used in the data stream.

Visibility: Expert

Implements IChunkData.

◆ GetScan3dInvalidDataValue()

float64_t GetScan3dInvalidDataValue ( ) const

virtual

Description: Returns the Invalid Data Value used for the image included in the payload.

Visibility: Expert

Implements IChunkData.

◆ GetScan3dTransformValue()

float64_t GetScan3dTransformValue ( ) const

virtual

Description: Returns the transform value.

Visibility: Expert

Implements IChunkData.

◆ GetScanLineSelector()

int64_t GetScanLineSelector ( ) const

virtual

Description: Index for vector representation of one chunk value per line in an image.

Visibility: Expert

Implements IChunkData.

◆ GetSequencerSetActive()

int64_t GetSequencerSetActive ( ) const

virtual

Description: Returns the index of the active set of the running sequencer included in the payload.

Visibility:

Implements IChunkData.

◆ GetSerialData()

uint8_t * GetSerialData ( ) const

virtual

Description: Returns the serial data that was received.

Visibility:

Implements IChunkData.

◆ GetSerialDataLength()

int64_t GetSerialDataLength ( ) const

virtual

Description: Returns the length of the received serial data that was included in the payload.

Visibility:

Implements IChunkData.

◆ GetSerialReceiveOverflow()

bool GetSerialReceiveOverflow ( ) const

virtual

Description: Returns the status of the chunk serial receive overflow.

Visibility:

Implements IChunkData.

◆ GetStreamChannelID()

int64_t GetStreamChannelID ( ) const

virtual

Description: Returns identifier of the stream channel used to carry the block.

Visibility: Expert

Implements IChunkData.

◆ GetTimerValue()

float64_t GetTimerValue ( ) const

virtual

Description: Returns the value of the selected Timer at the time of the FrameStart internal event.

Visibility: Expert

Implements IChunkData.

◆ GetTimestamp()

int64_t GetTimestamp ( ) const

virtual

Description: Returns the Timestamp of the image.

Visibility:

Implements IChunkData.

◆ GetTimestampLatchValue()

int64_t GetTimestampLatchValue ( ) const

virtual

Description: Returns the last Timestamp latched with the TimestampLatch command.

Visibility: Expert

Implements IChunkData.

◆ GetTransferBlockID()

int64_t GetTransferBlockID ( ) const

virtual

Description: Returns the unique identifier of the transfer block used to transport the payload.

Visibility: Expert

Implements IChunkData.

◆ GetTransferQueueCurrentBlockCount()

int64_t GetTransferQueueCurrentBlockCount ( ) const

virtual

Description: Returns the current number of blocks in the transfer queue.

Visibility: Expert

Implements IChunkData.

◆ GetWidth()

int64_t GetWidth ( ) const

virtual

Description: Returns the width of the image included in the payload.

Visibility:

Implements IChunkData.

◆ SetChunks()

void SetChunks ( GenApi::INodeMap & pNodeMap )

virtual

Implements IChunkData.

Friends And Related Symbol Documentation

◆ ChunkDataImpl

friend class ChunkDataImpl

friend

The documentation for this class was generated from the following file:

include/ChunkData.h

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ChunkData() [1/2]

◆ ChunkData() [2/2]

◆ ~ChunkData()

Member Function Documentation

◆ GetBlackLevel()

◆ GetCompressionMode()

◆ GetCompressionRatio()

◆ GetCounterValue()

◆ GetCRC()

◆ GetCurrentDatarate()

◆ GetEnable()

◆ GetEncoderValue()

◆ GetExposureEndLineStatusAll()

◆ GetExposureTime()

◆ GetFrameID()

◆ GetGain()

◆ GetHeight()

◆ GetImage()

◆ GetInferenceBoundingBoxResult()

◆ GetInferenceConfidence()

◆ GetInferenceFrameId()

◆ GetInferenceResult()

◆ GetLinePitch()

◆ GetLineStatusAll()

◆ GetModeActive()

◆ GetOffsetX()

◆ GetOffsetY()

◆ GetPartSelector()

◆ GetPixelDynamicRangeMax()

◆ GetPixelDynamicRangeMin()

◆ GetScan3dAxisMax()

◆ GetScan3dAxisMin()

◆ GetScan3dCoordinateOffset()

◆ GetScan3dCoordinateReferenceValue()

◆ GetScan3dCoordinateScale()

◆ GetScan3dInvalidDataFlag()

◆ GetScan3dInvalidDataValue()

◆ GetScan3dTransformValue()

◆ GetScanLineSelector()

◆ GetSequencerSetActive()

◆ GetSerialData()

◆ GetSerialDataLength()

◆ GetSerialReceiveOverflow()

◆ GetStreamChannelID()

◆ GetTimerValue()

◆ GetTimestamp()

◆ GetTimestampLatchValue()

◆ GetTransferBlockID()

◆ GetTransferQueueCurrentBlockCount()

◆ GetWidth()

◆ SetChunks()

Friends And Related Symbol Documentation

◆ ChunkDataImpl