GenDcPart1D Class Reference

Class for a GenDC 1D part descriptor. More...

#include <decl_gendc_descriptor.hpp>

Inherits GenDcPart.

Public Member Functions
std::uint64_t	GetSize () const
	Return the size of the GenDC 1D part.
std::uint16_t	GetPadding () const
	Return the padding of this GenDC 1D part.
void	SetSize (std::uint64_t size)
	Set the size of the GenDC 1D part.
void	SetPadding (std::uint16_t padding)
	Set the padding of this GenDC 1D part.
Public Member Functions inherited from GenDcPart
std::size_t	GetOffset () const
	Return the offset of this part descriptor in the GenDC descriptor.
GenDCPartType	GetType () const
	Return the type of this GenDC part descriptor.
GenDcPartFlags	GetFlags () const
	Return the flags of this GenDC part.
std::uint32_t	GetHeaderSize () const
	Return the size of this GenDC part descriptor.
PfncFormat	GetFormat () const
	Return the data format of this GenDC part.
std::uint16_t	GetFlowId () const
	Return the Flow ID of this GenDC part.
std::size_t	GetFlowOffset () const
	Return the Flow offset of this GenDC part.
std::size_t	GetDataSize () const
	Return the Data size of this GenDC part.
std::size_t	GetDataOffset () const
	Return the Data offset of this GenDC part.
void	SetFlags (GenDcPartFlags flags)
	Set the flags of this GenDC part.
void	SetDataSize (std::size_t size)
	Set the Data size of this GenDC part.
void	SetDataOffset (std::size_t offset)
	Set the Data offset of this GenDC part.

Detailed Description

Class for a GenDC 1D part descriptor.

Member Function Documentation

GetPadding()

std::uint16_t GetPadding ( ) const

inline

Return the padding of this GenDC 1D part.

Returns

Size of the padding at the end of the GenDC Part (in bytes).

Exceptions

Any	exception derived from std::exception including CvbException.

GetSize()

std::uint64_t GetSize ( ) const

inline

Return the size of the GenDC 1D part.

Returns

Size of the 1D GenDC Part (in number of elements according to GenDC parts Format).

Exceptions

Any	exception derived from std::exception including CvbException.

SetPadding()

void SetPadding ( std::uint16_t padding )

inline

Set the padding of this GenDC 1D part.

Parameters

[in]

padding

Size of the padding at the end of the GenDC Part (in bytes).

Exceptions

Any	exception derived from std::exception including CvbException.

Note

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

SetSize()

void SetSize ( std::uint64_t size )

inline

Set the size of the GenDC 1D part.

Parameters

[in]

size

Size of the 1D GenDC Metadata Part (in number of elements according to GenDC parts Format).

Exceptions

Any	exception derived from std::exception including CvbException.

Note

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