GenDcPart Class Reference

Class for a generic GenDC part descriptor. More...

#include <decl_gendc_descriptor.hpp>

Inherited by GenDcPart1D, GenDcPart2D, and GenDcPartMetadata.

Public Member Functions
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 generic GenDC part descriptor.

Member Function Documentation

GetDataOffset()

std::size_t GetDataOffset ( ) const

inline

Return the Data offset of this GenDC part.

Returns

Offset in bytes of the start of the Part's data section relative to the start of the Container's Descriptor for linear addressing.

Exceptions

Any	exception derived from std::exception including CvbException.

GetDataSize()

std::size_t GetDataSize ( ) const

inline

Return the Data size of this GenDC part.

Returns

Size of the GenDC part's data in bytes.

Exceptions

Any	exception derived from std::exception including CvbException.

GetFlags()

GenDcPartFlags GetFlags ( ) const

inline

Return the flags of this GenDC part.

Returns

Flags specifying the characteristics and format of the GenDC part.

Exceptions

Any	exception derived from std::exception including CvbException.

GetFlowId()

std::uint16_t GetFlowId ( ) const

inline

Return the Flow ID of this GenDC part.

Returns

Unique identifier of the data Flow used to transport and store the GenDC part's data.

Exceptions

Any	exception derived from std::exception including CvbException.

GetFlowOffset()

std::size_t GetFlowOffset ( ) const

inline

Return the Flow offset of this GenDC part.

Returns

Offset in bytes of the Part's data in the data Flow used to transport and store the GenDC part's data relative to the Flows' base address.

Exceptions

Any	exception derived from std::exception including CvbException.

GetFormat()

PfncFormat GetFormat ( ) const

inline

Return the data format of this GenDC part.

Returns

Data format of the GenDC part.

Exceptions

Any	exception derived from std::exception including CvbException.

GetHeaderSize()

std::uint32_t GetHeaderSize ( ) const

inline

Return the size of this GenDC part descriptor.

Returns

Size in bytes of the GenDC part descriptor including Type specific fields.

Exceptions

Any	exception derived from std::exception including CvbException.

GetOffset()

std::size_t GetOffset ( ) const

inline

Return the offset of this part 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.

GetType()

GenDCPartType GetType ( ) const

inline

Return the type of this GenDC part descriptor.

Returns

Type of this GenDC part descriptor.

Exceptions

Any	exception derived from std::exception including CvbException.

SetDataOffset()

void SetDataOffset ( std::size_t offset )

inline

Set the Data offset of this GenDC part.

Parameters

[in]

offset

Offset in bytes of the start of the Part's data section relative to the start of the Container's Descriptor for linear addressing.

Exceptions

Any	exception derived from std::exception including CvbException.

Note

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

SetDataSize()

void SetDataSize ( std::size_t size )

inline

Set the Data size of this GenDC part.

Parameters

[in]

size

Size of the GenDC part's data in bytes.

Exceptions

Any	exception derived from std::exception including CvbException.

Note

The data size cannot be larger than the size specified during construction.

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

SetFlags()

void SetFlags ( GenDcPartFlags flags )

inline

Set the flags of this GenDC part.

Parameters

[in]

flags

Flags specifying the characteristics and format of the GenDC part.

Exceptions

Any	exception derived from std::exception including CvbException.

Note

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