Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



IPvMultiPartSection Class Referenceabstract

One section (part) of a multi-part container. More...

Public Member Functions

virtual const uint8_t * GetDataPointer () const =0
 Returns the section's data pointer. More...
 
virtual uint32_t GetSize () const =0
 Returns the section's maximum possible data size in bytes. More...
 
virtual uint32_t GetEffectiveSize () const =0
 Returns the section's maximum possible data size in bytes. More...
 
virtual PvMultiPartDataType GetDataType () const =0
 Returns the data type of the section. More...
 
virtual operator IPvImage * ()=0
 IPvImage pointer cast operator. More...
 
virtual operator IPvImageJPEG * ()=0
 IPvImageJPEG pointer cast operator. More...
 
virtual operator IPvChunkData * ()=0
 IPvChunkData pointer cast operator. More...
 
virtual IPvImageGetImage ()=0
 Returns an IPvImage interface to the section. More...
 
virtual IPvImageJPEGGetJPEG ()=0
 Returns an IPvImageJPEG interface to the section. More...
 
virtual IPvChunkDataGetChunkData ()=0
 Returns an IPvChunkData interface to the section. More...
 
virtual uint32_t GetSourceID () const =0
 Returns the source ID of the section. More...
 
virtual uint32_t GetDataPurposeID () const =0
 Returns the data purpose ID of the section. More...
 
virtual uint32_t GetRegionID () const =0
 Returns the region ID of the section. More...
 
virtual uint32_t GetAdditionalZones () const =0
 
virtual uint32_t GetZoneDirectionMask () const =0
 

Detailed Description

One section (part) of a multi-part container.

Member Function Documentation

◆ GetAdditionalZones()

uint32_t IPvMultiPartSection::GetAdditionalZones ( ) const
pure virtual
Returns
Returns additional zone count of the section.

Reports the number of additional zones in the data part. The number of zones (contiguous bands) is equal to the value of this field plus one (0 indexed value).

See GigE Vision specification for more information on zones in the multi-part context.

Returns
Addtional zone count for the section.

◆ GetChunkData()

IPvChunkData * IPvMultiPartSection::GetChunkData ( )
pure virtual

Returns an IPvChunkData interface to the section.

Returns a point to an IPvChunkData interface to the section if the section is PvMultiPartChunkData.

Return NULL if any other data type.

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

The chunk data section is always last in a multi-part container.

Returns
IPvChunkData interface to the section.

◆ GetDataPointer()

uint8_t * IPvMultiPartSection::GetDataPointer ( ) const
pure virtual

Returns the section's data pointer.

Returns
A pointer to the memory pointer.

◆ GetDataPurposeID()

uint32_t IPvMultiPartSection::GetDataPurposeID ( ) const
pure virtual

Returns the data purpose ID of the section.

The data purpose ID is integer used to tag parts having a different purpose. Different color planes would share the same Data Purpose ID, while a 3D data and validity mask parts would use different Data Purpose ID.

See GigE Vision specification for more information on the data purpose ID in the multi-part context.

Returns
Data purpose ID of the section.

◆ GetDataType()

PvMultiPartDataType IPvMultiPartSection::GetDataType ( ) const
pure virtual

Returns the data type of the section.

Returns
Section data type.

◆ GetEffectiveSize()

uint32_t IPvMultiPartSection::GetEffectiveSize ( ) const
pure virtual

Returns the section's maximum possible data size in bytes.

Returns
Maximum possible data size in bytes.

◆ GetImage()

IPvImage * IPvMultiPartSection::GetImage ( )
pure virtual

Returns an IPvImage interface to the section.

Returns a point to an IPvImage interface to the section if the section is PvMultiPart2DImage, PvMultiPart2DPlaneOfBiPlanar, PvMultiPart2DPlaneOfTriPlanar, PvMultiPart2DPlaneOfQuadPlanar, PvMultiPart3DImage, PvMultiPart3DPlaneOfBiPlanar, PvMultiPart3DPlaneOfTriPlanar, PvMultiPart3DPlaneOfQuadPlanar or PvMultiPartConfidenceMap.

Return NULL if any other data type.

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

Returns
IPvImage interface to the section.

◆ GetJPEG()

IPvImageJPEG * IPvMultiPartSection::GetJPEG ( )
pure virtual

Returns an IPvImageJPEG interface to the section.

Returns a point to an IPvImageJPEG interface to the section if the section is PvMultiPartJPEGImage or PvMultiPartJPEGImage2000.

Return NULL if any other data type.

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

Returns
IPvImageJPEG interface to the section.

◆ GetRegionID()

uint32_t IPvMultiPartSection::GetRegionID ( ) const
pure virtual

Returns the region ID of the section.

The registion ID is an integer used to tag parts that belong to the same region. This can be used when data from different regions is transmitted in the same block.

See GigE Vision specification for more information on the region ID in the multi-part context.

Returns
Region ID of the section.

◆ GetSize()

uint32_t IPvMultiPartSection::GetSize ( ) const
pure virtual

Returns the section's maximum possible data size in bytes.

Returns
Maximum possible data size in bytes.

◆ GetSourceID()

uint32_t IPvMultiPartSection::GetSourceID ( ) const
pure virtual

Returns the source ID of the section.

The source ID is an integer used to identify data produced by the same source.

See GigE Vision specification for more information on sources in the multi-part context.

Returns
Source ID of the section.

◆ GetZoneDirectionMask()

uint32_t IPvMultiPartSection::GetZoneDirectionMask ( ) const
pure virtual
Returns
Returns the zone direction mask of the section.

Reports the transmission direction of each zone. bit 0 (msb)

  • Direction of zone 0. Reports the transmission direction of zone ID 0. When set to zero, the zone is transmitted top-down (lowest data addresses first). Otherwise, it is transmitted bottom-up (highest data addresses first). bit 1
  • Direction of zone 1. Reports the transmission direction of zone ID 1. When set to zero, the zone is transmitted top-down (lowest data addresses first). Otherwise, it is transmitted bottom up (highest data addresses first).
  • ...

See GigE Vision specification for more information on zones in the multi-part context.

Returns
Zone direction mask of the section.

◆ operator IPvChunkData *()

IPvMultiPartSection::operator IPvChunkData * ( )
pure virtual

IPvChunkData pointer cast operator.

See GetChunkData for more information.

Returns
IPvChunkData interface to the section.

◆ operator IPvImage *()

IPvMultiPartSection::operator IPvImage * ( )
pure virtual

IPvImage pointer cast operator.

See GetImage for more information.

Returns
IPvImage interface to the section.

◆ operator IPvImageJPEG *()

IPvMultiPartSection::operator IPvImageJPEG * ( )
pure virtual

IPvImageJPEG pointer cast operator.

See GetImageJPEG for more information.

Returns
IPvImageJPEG interface to the section.

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

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