One component in a GenDC container. A container can be formed by one or more components. More...

#include <PvGenericDataContainer.h>

Public Member Functions
virtual const GenDCComponentHeader *	GetHeader () const =0
	Returns a const pointer to the underlying GenDC component header.

virtual GenDCComponentHeader *	GetMutableHeader ()=0
	Returns a mutable pointer to the underlying GenDC component header.

virtual uint16_t	GetFlags () const =0
	Return the component's flags.

virtual uint32_t	GetHeaderSize () const =0
	Returns the size of this component's header.

virtual uint16_t	GetGroupID () const =0
	Returns the group identifier of this component. Components sharing a group ID are related together in some manner.

virtual uint16_t	GetSourceID () const =0
	Returns the identifier for the source that generated this component.

virtual uint16_t	GetRegionID () const =0
	Returns the region identifier of this component.

virtual uint32_t	GetRegionOffsetX () const =0
	Returns the region offset in the X axis for this component.

virtual uint32_t	GetRegionOffsetY () const =0
	Returns the region offset in the Y axis for this component.

virtual uint64_t	GetTimestamp () const =0
	Returns the data creation start timestamp for this component, in nanoseconds.

virtual uint64_t	GetTypeID () const =0
	Returns the SFNC ComponentIdValue for this component.

virtual PvComponentType	GetTypeIDEnum () const =0
	Returns the SFNC ComponentIdValue for this component, as an enum.

virtual uint32_t	GetFormat () const =0
	Returns the SFNC pixel format for this component.

virtual uint64_t	GetPartHeaderOffset (uint32_t aIndex) const =0
	Returns the data offset for the part associated with the index.

virtual uint32_t	GetPartCount () const =0
	Returns the parts count included by this component.

virtual const IPvGenericDataPart *	GetPart (uint32_t aIndex) const =0
	Indexed part const accessor.

virtual IPvGenericDataPart *	GetPart (uint32_t aIndex)=0
	Indexed part accessor.

virtual const IPvGenericDataPart *	operator[] (uint32_t aIndex) const =0
	Indexed part const accessor.

virtual IPvGenericDataPart *	operator[] (uint32_t aIndex)=0
	Indexed part accessor.

virtual uint32_t	AddPart (PvGenDCPartType aPartType, uint32_t aFlow)=0
	Creates a new part in the component.

Detailed Description

One component in a GenDC container. A container can be formed by one or more components.

Member Function Documentation

◆ AddPart()

virtual uint32_t IPvGenericDataComponent::AddPart	(	PvGenDCPartType	aPartType,
		uint32_t	aFlow
	)

pure virtual

Creates a new part in the component.

Adds a new part of the specified type to the component and returns its index. The part can then be accessed using GetPart() with the returned index.

Parameters

[in]	aPartType	The type of part to create (e.g., PvGenDCPart2D, PvGenDCPartMetadataChunk).
[in]	aFlow	The flow ID for this part.

Returns: The zero-based index of the newly created part.

◆ GetFlags()

virtual uint16_t IPvGenericDataComponent::GetFlags ( ) const

pure virtual

Return the component's flags.

If the component is marked as invalid by the source, the flags first bit is set to 1.

#IPvGenericDataComponent::IsValid can be used to assert if the component is valid.

Returns: An integer holding this component's flags.

◆ GetFormat()

virtual uint32_t IPvGenericDataComponent::GetFormat ( ) const

pure virtual

Returns the SFNC pixel format for this component.

The format returned by this function applies to the whole component. If the component includes a single part, this format matches its part.

For planar formats, the component format is the encapsulating format.

The Data8 format is used for non-pixel formats.

Returns: Pixel format.

◆ GetGroupID()

virtual uint16_t IPvGenericDataComponent::GetGroupID ( ) const

pure virtual

Returns the group identifier of this component. Components sharing a group ID are related together in some manner.

Returns: Group identifier.

◆ GetHeader()

virtual const GenDCComponentHeader * IPvGenericDataComponent::GetHeader ( ) const

pure virtual

Returns a const pointer to the underlying GenDC component header.

This pointer references descriptor-owned memory and remains valid as long as the container stays valid. The header must not be modified through this pointer.

Returns: Const pointer to the GenDC component header.

◆ GetHeaderSize()

virtual uint32_t IPvGenericDataComponent::GetHeaderSize ( ) const

pure virtual

Returns the size of this component's header.

The size of a GenDC component header is not static, as it can vary with its number of parts. If needed, this method can be used to fetch the exact size.

Returns: An integer with this component's header size.

◆ GetMutableHeader()

virtual GenDCComponentHeader * IPvGenericDataComponent::GetMutableHeader ( )

pure virtual

Returns a mutable pointer to the underlying GenDC component header.

This pointer can be used to edit the component header fields directly, in accordance with the GenDC specification. Callers must ensure synchronization when modifying headers.

Returns: Mutable pointer to the GenDC component header.

◆ GetPart() [1/2]

virtual const IPvGenericDataPart * IPvGenericDataComponent::GetPart ( uint32_t aIndex ) const

pure virtual

Indexed part const accessor.

Parameters

[in] aIndex Zero-based index of the part.

Returns: Returns a const part interface from its index.

◆ GetPart() [2/2]

virtual IPvGenericDataPart * IPvGenericDataComponent::GetPart ( uint32_t aIndex )

pure virtual

Indexed part accessor.

Parameters

[in] aIndex Zero-based index of the part.

Returns: Returns a part interface from its index.

◆ GetPartCount()

virtual uint32_t IPvGenericDataComponent::GetPartCount ( ) const

pure virtual

Returns the parts count included by this component.

Returns: The number of parts.

◆ GetPartHeaderOffset()

virtual uint64_t IPvGenericDataComponent::GetPartHeaderOffset ( uint32_t aIndex ) const

pure virtual

Returns the data offset for the part associated with the index.

The part offset can be used to retrieve the part header from the start of the container.

Returns: Part header offset, in bytes.

◆ GetRegionID()

virtual uint16_t IPvGenericDataComponent::GetRegionID ( ) const

pure virtual

Returns the region identifier of this component.

Returns: Region identifier.

◆ GetRegionOffsetX()

virtual uint32_t IPvGenericDataComponent::GetRegionOffsetX ( ) const

pure virtual

Returns the region offset in the X axis for this component.

Returns: Region offset in the X axis.

◆ GetRegionOffsetY()

virtual uint32_t IPvGenericDataComponent::GetRegionOffsetY ( ) const

pure virtual

Returns the region offset in the Y axis for this component.

Returns: Region offset in the Y axis.

◆ GetSourceID()

virtual uint16_t IPvGenericDataComponent::GetSourceID ( ) const

pure virtual

Returns the identifier for the source that generated this component.

Returns: Source identifier.

◆ GetTimestamp()

virtual uint64_t IPvGenericDataComponent::GetTimestamp ( ) const

pure virtual

Returns the data creation start timestamp for this component, in nanoseconds.

Returns: Data creation start timestamp.

◆ GetTypeID()

virtual uint64_t IPvGenericDataComponent::GetTypeID ( ) const

pure virtual

Returns the SFNC ComponentIdValue for this component.

Returns: Component type ID.

◆ GetTypeIDEnum()

virtual PvComponentType IPvGenericDataComponent::GetTypeIDEnum ( ) const

pure virtual

Returns the SFNC ComponentIdValue for this component, as an enum.

To get the exact type integer value (e.g. for custom types), GetTypeID must be called instead.

Returns: The PvComponentType associated with this part's data.

◆ operator[]() [1/2]

virtual const IPvGenericDataPart * IPvGenericDataComponent::operator[] ( uint32_t aIndex ) const

pure virtual

Indexed part const accessor.

Parameters

[in] aIndex Zero-based index of the part.

Returns: Returns a const part interface from its index.

◆ operator[]() [2/2]

virtual IPvGenericDataPart * IPvGenericDataComponent::operator[] ( uint32_t aIndex )

pure virtual

Indexed part accessor.

Parameters

[in] aIndex Zero-based index of the part.

Returns: Returns a part interface from its index.

The documentation for this class was generated from the following file:

PvGenericDataContainer.h

eBUS SDK v7.0.1.7536 API

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddPart()

◆ GetFlags()

◆ GetFormat()

◆ GetGroupID()

◆ GetHeader()

◆ GetHeaderSize()

◆ GetMutableHeader()

◆ GetPart() [1/2]

◆ GetPart() [2/2]

◆ GetPartCount()

◆ GetPartHeaderOffset()

◆ GetRegionID()

◆ GetRegionOffsetX()

◆ GetRegionOffsetY()

◆ GetSourceID()

◆ GetTimestamp()

◆ GetTypeID()

◆ GetTypeIDEnum()

◆ operator[]() [1/2]

◆ operator[]() [2/2]