Class for a GenDC component descriptor. More...

#include <decl_gendc_descriptor.hpp>

Public Member Functions
std::size_t	GetOffset () const
	Return the offset of this component descriptor in the GenDC descriptor.

GenDcComponentFlags	GetFlags () const
	Return the flags of this GenDC component.

std::uint32_t	GetHeaderSize () const
	Return the size of this GenDC component descriptor.

std::uint16_t	GetGroupId () const
	Return the Group ID of this GenDC component.

std::uint16_t	GetSourceId () const
	Return the Source ID of this GenDC component.

std::uint16_t	GetRegionId () const
	Return the Source ID of this GenDC component.

std::uint32_t	GetRegionOffsetX () const
	Return the X Offset of this GenDC component's region.

std::uint32_t	GetRegionOffsetY () const
	Return the Y Offset of this GenDC component's region.

std::uint64_t	GetTimestamp () const
	Return the timestamp of this GenDC component's generation.

ComponentId	GetTypeId () const
	Return the type identifier of this GenDC component.

PfncFormat	GetFormat () const
	Return the format of the whole GenDC component (including all its parts).

const std::vector< GenDCPartVariant > &	GetParts () const
	Return the part descriptors of this GenDC component.

std::vector< GenDCPartVariant > &	GetParts ()
	Return the part descriptors of this GenDC component.

void	SetFlags (GenDcComponentFlags flags)
	Set the flags of this GenDC component.

void	SetGroupId (std::uint16_t id)
	Set the Group ID of this GenDC component.

void	SetSourceId (std::uint16_t id)
	Set the Source ID of this GenDC component.

void	SetRegionId (std::uint16_t id)
	Set the Source ID of this GenDC component.

void	SetRegionOffsetX (std::uint32_t offset)
	Set the X Offset of this GenDC component's region.

void	SetRegionOffsetY (std::uint32_t offset)
	Set the Y Offset of this GenDC component's region.

void	SetTimestamp (std::uint64_t timestamp)
	Set the timestamp of this GenDC component's generation.

Detailed Description

Class for a GenDC component descriptor.

Member Function Documentation

◆ GetFlags()

GenDcComponentFlags GetFlags ( ) const

inline

Return the flags of this GenDC component.

Returns: Flags specifying the characteristics and format of the GenDC component.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ GetFormat()

PfncFormat GetFormat ( ) const

inline

Return the format of the whole GenDC component (including all its parts).

Returns: Format of the whole GenDC component (including all its Parts).

Exceptions

Any	exception derived from std::exception including CvbException.

Note: If the GenDC component has only a single Part the component's Format is the same as the GenDC part's Format.

◆ GetGroupId()

std::uint16_t GetGroupId ( ) const

inline

Return the Group ID of this GenDC component.

Returns: Group identifier for a Component in the GenDC container.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ GetHeaderSize()

std::uint32_t GetHeaderSize ( ) const

inline

Return the size of this GenDC component descriptor.

Returns: Size of the GenDC component header in bytes including the variable sized PartOffset array.

Exceptions

Any	exception derived from std::exception including CvbException.

Note: the GenDC Component's part headers are not included.

◆ GetOffset()

std::size_t GetOffset ( ) const

inline

Return the offset of this component descriptor in the GenDC descriptor.

Returns: Offset in bytes from the start of the GenDC descriptor.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ GetParts() [1/2]

std::vector< GenDCPartVariant > & GetParts ( )

inline

Return the part descriptors of this GenDC component.

Returns: Vector of part descriptors in this GenDC component.

Exceptions

Any	exception derived from std::exception including CvbException.

Note: This method is only supported for user-created GenDC Descriptors.

◆ GetParts() [2/2]

const std::vector< GenDCPartVariant > & GetParts ( ) const

inline

Return the part descriptors of this GenDC component.

Returns: Vector of part descriptors in this GenDC component.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ GetRegionId()

std::uint16_t GetRegionId ( ) const

inline

Return the Source ID of this GenDC component.

Returns: Identifier of the data source's region that generated the GenDC Component.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ GetRegionOffsetX()

std::uint32_t GetRegionOffsetX ( ) const

inline

Return the X Offset of this GenDC component's region.

Returns: X Offset of the region (in pixels).

Exceptions

Any	exception derived from std::exception including CvbException.

◆ GetRegionOffsetY()

std::uint32_t GetRegionOffsetY ( ) const

inline

Return the Y Offset of this GenDC component's region.

Returns: Y Offset of the region (in pixels).

Exceptions

Any	exception derived from std::exception including CvbException.

◆ GetSourceId()

std::uint16_t GetSourceId ( ) const

inline

Return the Source ID of this GenDC component.

Returns: Identifier of the data source that generated the GenDC Component.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ GetTimestamp()

std::uint64_t GetTimestamp ( ) const

inline

Return the timestamp of this GenDC component's generation.

Returns: Timestamp of the start of the GenDC component's data creation in nanoseconds.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ GetTypeId()

ComponentId GetTypeId ( ) const

inline

Return the type identifier of this GenDC component.

Returns: GenD component's type identifier.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ SetFlags()

void SetFlags ( GenDcComponentFlags flags )

inline

Set the flags of this GenDC component.

Parameters

[in] flags Flags specifying the characteristics and format of the GenDC component.

Exceptions

Any	exception derived from std::exception including CvbException.

Note: This method is only supported for user-created GenDC Descriptors.

◆ SetGroupId()

void SetGroupId ( std::uint16_t id )

inline

Set the Group ID of this GenDC component.

Parameters

[in] id Group identifier for a Component in the GenDC container.

Exceptions

Any	exception derived from std::exception including CvbException.

Note: This method is only supported for user-created GenDC Descriptors.

◆ SetRegionId()

void SetRegionId ( std::uint16_t id )

inline

Set the Source ID of this GenDC component.

Parameters

[in] id Identifier of the data source that generated the GenDC Component.

Exceptions

Any	exception derived from std::exception including CvbException.

Note: This method is only supported for user-created GenDC Descriptors.

◆ SetRegionOffsetX()

void SetRegionOffsetX ( std::uint32_t offset )

inline

Set the X Offset of this GenDC component's region.

Parameters

[in] offset X Offset of the region (in pixels).

Exceptions

Any	exception derived from std::exception including CvbException.

Note: This method is only supported for user-created GenDC Descriptors.

◆ SetRegionOffsetY()

void SetRegionOffsetY ( std::uint32_t offset )

inline

Set the Y Offset of this GenDC component's region.

Parameters

[in] offset Y Offset of the region (in pixels).

Exceptions

Any	exception derived from std::exception including CvbException.

Note: This method is only supported for user-created GenDC Descriptors.

◆ SetSourceId()

void SetSourceId ( std::uint16_t id )

inline

Set the Source ID of this GenDC component.

Parameters

[in] id Identifier of the data source's region that generated the GenDC Component.

Exceptions

Any	exception derived from std::exception including CvbException.

Note: This method is only supported for user-created GenDC Descriptors.

◆ SetTimestamp()

void SetTimestamp ( std::uint64_t timestamp )

inline

Set the timestamp of this GenDC component's generation.

Parameters

[in] timestamp Timestamp of the start of the GenDC component's data creation in nanoseconds.

Exceptions

Any	exception derived from std::exception including CvbException.

Note: This method is only supported for user-created GenDC Descriptors.

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetFlags()

◆ GetFormat()

◆ GetGroupId()

◆ GetHeaderSize()

◆ GetOffset()

◆ GetParts() [1/2]

◆ GetParts() [2/2]

◆ GetRegionId()

◆ GetRegionOffsetX()

◆ GetRegionOffsetY()

◆ GetSourceId()

◆ GetTimestamp()

◆ GetTypeId()

◆ SetFlags()

◆ SetGroupId()

◆ SetRegionId()

◆ SetRegionOffsetX()

◆ SetRegionOffsetY()

◆ SetSourceId()

◆ SetTimestamp()