Class for a GenDC container descriptor. More...
#include <decl_gendc_descriptor.hpp>
Public Member Functions | |
Version | GetVersion () const |
Return the GenDC descriptor standards version. | |
GenDcDescriptorFlag | GetFlags () const |
Return the flags of this GenDC container. | |
std::uint32_t | GetHeaderSize () const |
Return the size of this GenDC container descriptor. | |
std::uint64_t | GetContainerId () const |
Return the identifier of GenDC container. | |
GenDcDescriptorVariableField | GetVariableFields () const |
Return the flags identifying the variable fields of this GenDC container. | |
std::uint64_t | GetDataSize () const |
Return the size of the GenDC data. | |
std::int64_t | GetDataOffset () const |
Return the offset of the GenDC data. | |
std::uint32_t | GetDescriptorSize () const |
Return the size of the GenDC container descriptor. | |
const std::vector< GenDcComponent > & | GetComponents () const |
Return the component descriptors of this GenDC container. | |
std::vector< GenDcComponent > & | GetComponents () |
Return the component descriptors of this GenDC container. | |
size_t | CalculateFlowCount () const |
Return the count of flows the container is transported in. | |
void | SetFlags (GenDcDescriptorFlag flags) |
Set the flags of this GenDC container. | |
void | SetContainerId (std::uint64_t id) |
Set the identifier of GenDC container. | |
void | SetVariableFields (GenDcDescriptorVariableField fields) |
Set the flags identifying the variable fields of this GenDC container. | |
void | SetDataSize (std::uint32_t size) |
Set the size of the GenDC data. | |
std::size_t | GetSerializedSize () const |
Get the size in bytes of this GenDC descriptor when serialized. | |
void | Serialize (std::uint8_t *buffer, std::size_t size) const |
Serialize this GenDC descriptor into a provided buffer. | |
std::vector< std::uint8_t > | Serialize () const |
Serialize this GenDC descriptor into a new buffer. | |
void * | Handle () const noexcept |
Return the Handle to the internal resource. | |
Static Public Member Functions | |
static std::unique_ptr< GenDcDescriptor > | Create (const GenDcDescriptorConfig &descriptorConfig) |
Create a GenDC descriptor. | |
static std::unique_ptr< GenDcDescriptor > | FromHandle (HandleGuard< GenDcDescriptor > &&guard) |
Creates a GenDC descriptor from a classic API handle. | |
Class for a GenDC container descriptor.
|
inline |
Return the count of flows the container is transported in.
Any | exception derived from std::exception including CvbException |
|
inlinestatic |
Create a GenDC descriptor.
[in] | descriptorConfig | Configuration object specifying components and parts. |
Any | exception derived from std::exception including CvbException. |
|
inlinestatic |
Creates a GenDC descriptor from a classic API handle.
[in] | guard | Life time guard for C-API handle. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the component descriptors of this GenDC container.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the component descriptors of this GenDC container.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the identifier of GenDC container.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the offset of the GenDC data.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the size of the GenDC data.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the size of the GenDC container descriptor.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the flags of this GenDC container.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the size of this GenDC container descriptor.
Any | exception derived from std::exception including CvbException. |
|
inline |
Get the size in bytes of this GenDC descriptor when serialized.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the flags identifying the variable fields of this GenDC container.
Any | exception derived from std::exception including CvbException. |
|
inline |
Return the GenDC descriptor standards version.
Any | exception derived from std::exception including CvbException. |
|
inlinenoexcept |
Return the Handle to the internal resource.
This function returns a pointer to the internal resource associated with the GenDC descriptor.
|
inline |
Serialize this GenDC descriptor into a new buffer.
Any | exception derived from std::exception including CvbException. |
|
inline |
Serialize this GenDC descriptor into a provided buffer.
[in] | buffer | A pointer to the beginning of a byte buffer to serialize into. |
[in] | size | Size in bytes of the provided buffer. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Set the identifier of GenDC container.
[in] | id | Container identifier. Strictly monotonically incrementing by 1 with each transmitted GenDC Container. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Set the size of the GenDC data.
[in] | size | Maximum size of the entire GenDC Container's data section in bytes. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Set the flags of this GenDC container.
[in] | flags | Flags specifying the characteristics and format of the GenDC container. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Set the flags identifying the variable fields of this GenDC container.
[in] | fields | Flags specifying which type of data information might vary during the GenDC Container reception |
Any | exception derived from std::exception including CvbException. |