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. | |
Class for a GenDC component descriptor.
|
inline |
Return the flags of this GenDC component.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the format of the whole GenDC component (including all its parts).
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the Group ID of this GenDC component.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the size of this GenDC component descriptor.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the offset of this component descriptor in the GenDC descriptor.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the part descriptors of this GenDC component.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the part descriptors of this GenDC component.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the Source ID of this GenDC component.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the X Offset of this GenDC component's region.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the Y Offset of this GenDC component's region.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the Source ID of this GenDC component.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the timestamp of this GenDC component's generation.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the type identifier of this GenDC component.
Any | exception derived from std::exception including CvbException. |
|
inline |
Set the flags of this GenDC component.
[in] | flags | Flags specifying the characteristics and format of the GenDC component. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Set the Group ID of this GenDC component.
[in] | id | Group identifier for a Component in the GenDC container. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Set the Source ID of this GenDC component.
[in] | id | Identifier of the data source that generated the GenDC Component. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Set the X Offset of this GenDC component's region.
[in] | offset | X Offset of the region (in pixels). |
Any | exception derived from std::exception including CvbException. |
|
inline |
Set the Y Offset of this GenDC component's region.
[in] | offset | Y Offset of the region (in pixels). |
Any | exception derived from std::exception including CvbException. |
|
inline |
Set the Source ID of this GenDC component.
[in] | id | Identifier of the data source's region that generated the GenDC Component. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Set the timestamp of this GenDC component's generation.
[in] | timestamp | Timestamp of the start of the GenDC component's data creation in nanoseconds. |
Any | exception derived from std::exception including CvbException. |