Pleora Technologies Inc. eBUS SDK v7.0.1.7536 API



Loading...
Searching...
No Matches
Public Member Functions | List of all members
IPvGenericDataPart Class Referenceabstract

One part in a GenDC component; the smallest unit in a GenDC container. More...

#include <PvGenericDataContainer.h>

Public Member Functions

virtual const GenDCPartHeader * GetHeader () const =0
 Returns a const pointer to the underlying GenDC part header.
 
virtual GenDCPartHeader * GetMutableHeader ()=0
 Returns a mutable pointer to the underlying GenDC part header.
 
virtual uint16_t GetHeaderType () const =0
 Returns the exact part's header type value, as an integer.
 
virtual PvGenDCPartType GetHeaderTypeEnum () const =0
 Returns the part's header type, as an enum.
 
virtual uint16_t GetFlags () const =0
 Returns the flags value for this part.
 
virtual uint32_t GetHeaderSize () const =0
 Returns the size of this part's header.
 
virtual uint32_t GetFormat () const =0
 Returns the pixel format value of this part.
 
virtual uint16_t GetFlowID () const =0
 Returns this part's flow ID.
 
virtual uint64_t GetFlowOffset () const =0
 Returns this part's flow offset.
 
virtual uint64_t GetDataSize () const =0
 Returns the part's data size in bytes.
 
virtual uint64_t GetDataOffset () const =0
 Returns an IPvGenDCPartTypeFields interface for this part.
 
virtual const uint8_t * GetDataPointer () const =0
 Returns the part's data pointer (const).
 
virtual uint8_t * GetDataPointer ()=0
 Returns the part's data pointer.
 
virtual operator const IPvGenDCImage * () const =0
 IPvImage const pointer cast operator.
 
virtual operator const IPvGenDCChunkData * () const =0
 IPvChunkData pointer cast operator.
 
virtual const IPvGenDCImage * GetGenDCImage () const =0
 Returns a pointer to an IPvGenDCImage interface to the part, if the header type is a 2D image.
 
virtual const IPvGenDCChunkData * GetGenDCChunkData () const =0
 Returns a pointer to an IPvGenDCChunkData interface to the part, if the header type is chunk metadata.
 
virtual const IPvGenDCChunkWriter * GetGenDCChunkWriter () const =0
 Returns a pointer to an IPvGenDCChunkWriter interface to the part, if the header type is chunk metadata.
 
virtual uint64_t GetReceptionTime () const =0
 Retrieves the reception time of the data container.
 
virtual PvResult GetMetadataSpecificFields (PvGenDCPartMetadataFields &aMetadataFields) const =0
 Retrieves a PvGenDCPartMetadataFields struct, if the header type is metadata.
 
virtual PvResult Get1DSpecificFields (PvGenDCPart1DFields &aSpecificFields) const =0
 Returns a PvGenDCPart1DFields struct, if the header type is 1D.
 
virtual PvResult Get2DSpecificFields (PvGenDCPart2DFields &aSpecificFields) const =0
 Returns a PvGenDCPart2DFields struct, if the header type is 2D.
 
virtual PvResult GetH264SpecificFields (PvGenDCPartH264Fields &aSpecificFields) const =0
 Returns a PvGenDCPartH264Fields struct, if the header type is H.264 compressed.
 

Detailed Description

One part in a GenDC component; the smallest unit in a GenDC container.

Member Function Documentation

◆ Get1DSpecificFields()

virtual PvResult IPvGenericDataPart::Get1DSpecificFields ( PvGenDCPart1DFields &  aSpecificFields) const
pure virtual

Returns a PvGenDCPart1DFields struct, if the header type is 1D.

The specific fields are an extended set of fields appended to the part data if the header is of the given type.

Returns
Includes:

◆ Get2DSpecificFields()

virtual PvResult IPvGenericDataPart::Get2DSpecificFields ( PvGenDCPart2DFields &  aSpecificFields) const
pure virtual

Returns a PvGenDCPart2DFields struct, if the header type is 2D.

The specific fields are an extended set of fields appended to the part data if the header is of the given type.

Returns
Includes:

◆ GetDataOffset()

virtual uint64_t IPvGenericDataPart::GetDataOffset ( ) const
pure virtual

Returns an IPvGenDCPartTypeFields interface for this part.

The type fields are specific to a part category, such as metadata, a 1D array, or a 2D image.

Returns
IPvGenDCPartTypeFields interface for this part.

Returns the part's data offset in bytes.

This offset is relative to the block linear address.

Instead, a pointer to this part's data can readily be obtained by using GetDataPointer().

Returns
Data offset in bytes.

◆ GetDataPointer() [1/2]

virtual const uint8_t * IPvGenericDataPart::GetDataPointer ( ) const
pure virtual

Returns the part's data pointer (const).

Returns
A const pointer to the memory pointer.

◆ GetDataPointer() [2/2]

virtual uint8_t * IPvGenericDataPart::GetDataPointer ( )
pure virtual

Returns the part's data pointer.

Returns
A pointer to the memory pointer.

◆ GetDataSize()

virtual uint64_t IPvGenericDataPart::GetDataSize ( ) const
pure virtual

Returns the part's data size in bytes.

If the container is final, the integer returned is the valid data size. Otherwise, the size is the maximum possible value the part can hold.

Returns
Data size in bytes.

◆ GetFlags()

virtual uint16_t IPvGenericDataPart::GetFlags ( ) const
pure virtual

Returns the flags value for this part.

Flags value are specific to the part type. Refer to the GenDC specification if needed.

Returns
An integer holding this part's flags.

◆ GetFlowID()

virtual uint16_t IPvGenericDataPart::GetFlowID ( ) const
pure virtual

Returns this part's flow ID.

Flows are used by the transport layer to carry the data and store it into memory. The IDs are attributed sequentially starting with the GenDC descriptor in flow 0.

If for any reason the flow ID mapped to this part data is needed, this method can be used.

Returns
An integer with this part's flow ID.

◆ GetFlowOffset()

virtual uint64_t IPvGenericDataPart::GetFlowOffset ( ) const
pure virtual

Returns this part's flow offset.

Flows are used by the transport layer to carry the data and store it into memory. The flow offset locates this part's data relative to the flow base address.

If for any reason the flow offset to this part data is needed, this method can be used.

◆ GetFormat()

virtual uint32_t IPvGenericDataPart::GetFormat ( ) const
pure virtual

Returns the pixel format value of this part.

Use this method to get the PFNC pixel format value representing the part's data.

Returns
An integer with this part's pixel format.

◆ GetGenDCChunkData()

virtual const IPvGenDCChunkData * IPvGenericDataPart::GetGenDCChunkData ( ) const
pure virtual

Returns a pointer to an IPvGenDCChunkData interface to the part, if the header type is chunk metadata.

Returns NULL if it is any other data type.

The returned pointer is owned by the part. The caller must not attempt to free or delete it.

Returns
IPvGenDCChunkData interface to the part.

◆ GetGenDCChunkWriter()

virtual const IPvGenDCChunkWriter * IPvGenericDataPart::GetGenDCChunkWriter ( ) const
pure virtual

Returns a pointer to an IPvGenDCChunkWriter interface to the part, if the header type is chunk metadata.

Returns NULL if it is any other data type.

This method provides access to chunk data writer. It is used in the context of eBUS Edge in writing Chunk Data to the GenDC Part.

The returned pointer is owned by the part. The caller must not attempt to free or delete it.

Returns
IPvGenDCChunkWriter interface to the part.

◆ GetGenDCImage()

virtual const IPvGenDCImage * IPvGenericDataPart::GetGenDCImage ( ) const
pure virtual

Returns a pointer to an IPvGenDCImage interface to the part, if the header type is a 2D image.

Returns NULL if it is any other data type.

The returned pointer is owned by the part. The caller must not attempt to free or delete it.

Returns
IPvGenDCImage interface to the part.

◆ GetH264SpecificFields()

virtual PvResult IPvGenericDataPart::GetH264SpecificFields ( PvGenDCPartH264Fields &  aSpecificFields) const
pure virtual

Returns a PvGenDCPartH264Fields struct, if the header type is H.264 compressed.

The specific fields are an extended set of fields appended to the part data if the header is of the given type.

Returns
Includes:

◆ GetHeader()

virtual const GenDCPartHeader * IPvGenericDataPart::GetHeader ( ) const
pure virtual

Returns a const pointer to the underlying GenDC part header.

This pointer references the descriptor-owned memory; it remains valid as long as the container stays valid. Modifying the data through this pointer is not permitted.

Returns
Const pointer to the GenDC part header.

◆ GetHeaderSize()

virtual uint32_t IPvGenericDataPart::GetHeaderSize ( ) const
pure virtual

Returns the size of this part's header.

The size of a GenDC part header is not static, as it can vary with its type specific fields. If needed, this method can be used to fetch the exact size.

Returns
An integer with this part's header size.

◆ GetHeaderType()

virtual uint16_t IPvGenericDataPart::GetHeaderType ( ) const
pure virtual

Returns the exact part's header type value, as an integer.

The part type value is defined by the 0x4000-0x4FFF range. The first 4 bits are used for the general category of the header type. The following 8 bits define the part subtype.

To get a generic enum representation of the part header type, use GetHeaderTypeEnum instead.

Returns
An integer matching the GenDC part header type.

◆ GetHeaderTypeEnum()

virtual PvGenDCPartType IPvGenericDataPart::GetHeaderTypeEnum ( ) const
pure virtual

Returns the part's header type, as an enum.

This part header type indicates the different type fields that can be associated with this part.

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

Returns
The PvGenDCPartType associated with this part's data.

◆ GetMetadataSpecificFields()

virtual PvResult IPvGenericDataPart::GetMetadataSpecificFields ( PvGenDCPartMetadataFields &  aMetadataFields) const
pure virtual

Retrieves a PvGenDCPartMetadataFields struct, if the header type is metadata.

The specific fields are an extended set of fields appended to the part data if the header is of the given type.

Returns
Includes:

◆ GetMutableHeader()

virtual GenDCPartHeader * IPvGenericDataPart::GetMutableHeader ( )
pure virtual

Returns a mutable pointer to the underlying GenDC part header.

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

Returns
Mutable pointer to the GenDC part header.

◆ GetReceptionTime()

virtual uint64_t IPvGenericDataPart::GetReceptionTime ( ) const
pure virtual

Retrieves the reception time of the data container.

The time is typically represented as a 64-bit unsigned integer, such as microseconds since a reference epoch (e.g., Unix epoch).

Returns
uint64_t The reception time value.

◆ operator const IPvGenDCChunkData *()

virtual IPvGenericDataPart::operator const IPvGenDCChunkData * ( ) const
pure virtual

IPvChunkData pointer cast operator.

See GetChunkData for more information.

For backward compatibility. Returns NULL if not convertible to IPvChunkData. Use GetGenDCChunkData() for GenDC-specific chunk interface.

Returns
IPvChunkData interface to the part.

◆ operator const IPvGenDCImage *()

virtual IPvGenericDataPart::operator const IPvGenDCImage * ( ) const
pure virtual

IPvImage const pointer cast operator.

See GetImage for more information.

For backward compatibility. Returns NULL if not convertible to IPvImage. Use GetGenDCImage() for GenDC-specific image interface.

Returns
IPvImage interface to the part.
The documentation for this class was generated from the following file:

Copyright (c) 2002-2026 Pleora Technologies Inc.
www.pleora.com