Class IPvMultiPartContainerWriter

Interface used to write to a multi-part container.

Inheritance

object

IPvMultiPartContainerReader

IPvMultiPartContainerWriter

IPvMultiPartContainer

Implements

IDisposable

Inherited Members

IPvMultiPartContainerReader.swigCMemOwn

IPvMultiPartContainerReader.Dispose()

IPvMultiPartContainerReader.this[uint]

IPvMultiPartContainerReader.GetPart(uint)

IPvMultiPartContainerReader.PartCount

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: eBUSDotNet

Assembly: eBUSDotNet.dll

Syntax

public class IPvMultiPartContainerWriter : IPvMultiPartContainerReader, IDisposable

Methods

AddChunkPart(uint, uint)

Adds a chunk data part to the index of a multi-part container.

Declaration

public virtual PvResult AddChunkPart(uint aMaxLength, uint aChunkLayoutID)

Parameters

Type	Name	Description
uint	aMaxLength	Maximum length for chunk data.
uint	aChunkLayoutID	Chunk layoud ID for the chunk data.

Returns

Type

Description

PvResult

Includes: #PvResult::Code::OK on success. #PvResult::Code::NOT_SUPPORTED if the PvBuffer accessed from this interfaced is not defined as a multi-part buffer. #PvResult::Code::ERR_OVERFLOW if the maximum number of parts supported by the GigE Vision specification has already been reached. #PvResult::Code::STATE_ERROR if the previously added part is of type chunk data which is only valid as the last part.

AddImagePart(PvMultiPartDataType, uint, uint, PvPixelType)

Adds an image part to the index of a multi-part container.

Declaration

public virtual PvResult AddImagePart(PvMultiPartDataType aDataType, uint aWidth, uint aMaxHeight, PvPixelType aPixelType)

Parameters

Type	Name	Description
PvMultiPartDataType	aDataType	Image data type. Must be between PvMultiPart2DImage and PvMultiPartConfidenceMap, inclusive.
uint	aWidth	Width of the image, in pixels.
uint	aMaxHeight	Height of the image, in pixels.
PvPixelType	aPixelType	Pixel type of the image.

Returns

Type

Description

PvResult

Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER aDataType does not represent an image, aWidth is zero or aHeight is zero. #PvResult::Code::NOT_SUPPORTED if the PvBuffer accessed from this interfaced is not defined as a multi-part buffer. #PvResult::Code::ERR_OVERFLOW if the maximum number of parts supported by the GigE Vision specification has already been reached. #PvResult::Code::STATE_ERROR if the previously added part is of type chunk data which is only valid as the last part.

AddImagePart(PvMultiPartDataType, uint, uint, PvPixelType, uint)

Adds an image part to the index of a multi-part container.

Declaration

public virtual PvResult AddImagePart(PvMultiPartDataType aDataType, uint aWidth, uint aMaxHeight, PvPixelType aPixelType, uint aOffsetX)

Parameters

Type	Name	Description
PvMultiPartDataType	aDataType	Image data type. Must be between PvMultiPart2DImage and PvMultiPartConfidenceMap, inclusive.
uint	aWidth	Width of the image, in pixels.
uint	aMaxHeight	Height of the image, in pixels.
PvPixelType	aPixelType	Pixel type of the image.
uint	aOffsetX	Offset X of the image, in pixels.

Returns

Type

Description

PvResult

Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER aDataType does not represent an image, aWidth is zero or aHeight is zero. #PvResult::Code::NOT_SUPPORTED if the PvBuffer accessed from this interfaced is not defined as a multi-part buffer. #PvResult::Code::ERR_OVERFLOW if the maximum number of parts supported by the GigE Vision specification has already been reached. #PvResult::Code::STATE_ERROR if the previously added part is of type chunk data which is only valid as the last part.

AddImagePart(PvMultiPartDataType, uint, uint, PvPixelType, uint, uint)

Adds an image part to the index of a multi-part container.

Declaration

public virtual PvResult AddImagePart(PvMultiPartDataType aDataType, uint aWidth, uint aMaxHeight, PvPixelType aPixelType, uint aOffsetX, uint aOffsetY)

Parameters

Type	Name	Description
PvMultiPartDataType	aDataType	Image data type. Must be between PvMultiPart2DImage and PvMultiPartConfidenceMap, inclusive.
uint	aWidth	Width of the image, in pixels.
uint	aMaxHeight	Height of the image, in pixels.
PvPixelType	aPixelType	Pixel type of the image.
uint	aOffsetX	Offset X of the image, in pixels.
uint	aOffsetY	Offset Y of the image, in pixels.

Returns

Type

Description

PvResult

Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER aDataType does not represent an image, aWidth is zero or aHeight is zero. #PvResult::Code::NOT_SUPPORTED if the PvBuffer accessed from this interfaced is not defined as a multi-part buffer. #PvResult::Code::ERR_OVERFLOW if the maximum number of parts supported by the GigE Vision specification has already been reached. #PvResult::Code::STATE_ERROR if the previously added part is of type chunk data which is only valid as the last part.

AddImagePart(PvMultiPartDataType, uint, uint, PvPixelType, uint, uint, ushort)

Adds an image part to the index of a multi-part container.

Declaration

public virtual PvResult AddImagePart(PvMultiPartDataType aDataType, uint aWidth, uint aMaxHeight, PvPixelType aPixelType, uint aOffsetX, uint aOffsetY, ushort aPaddingX)

Parameters

Type	Name	Description
PvMultiPartDataType	aDataType	Image data type. Must be between PvMultiPart2DImage and PvMultiPartConfidenceMap, inclusive.
uint	aWidth	Width of the image, in pixels.
uint	aMaxHeight	Height of the image, in pixels.
PvPixelType	aPixelType	Pixel type of the image.
uint	aOffsetX	Offset X of the image, in pixels.
uint	aOffsetY	Offset Y of the image, in pixels.
ushort	aPaddingX	Padding X of the image, in bytes.

Returns

Type

Description

PvResult

Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER aDataType does not represent an image, aWidth is zero or aHeight is zero. #PvResult::Code::NOT_SUPPORTED if the PvBuffer accessed from this interfaced is not defined as a multi-part buffer. #PvResult::Code::ERR_OVERFLOW if the maximum number of parts supported by the GigE Vision specification has already been reached. #PvResult::Code::STATE_ERROR if the previously added part is of type chunk data which is only valid as the last part.

AddJPEGPart(PvMultiPartDataType, uint, byte, ulong, uint)

Adds a JPEG part to the index of a multi-part container.

Declaration

public virtual PvResult AddJPEGPart(PvMultiPartDataType aDataType, uint aMaxLength, byte aFlag, ulong aTimestampTickFrequency, uint aDataFormat)

Parameters

Type	Name	Description
PvMultiPartDataType	aDataType	Multi-part data type. Either PvMultiPartJPEGImage or PvMultiPartJPEG2000Image.
uint	aMaxLength	Maximum length for the compressed image. Defined here as worse-case compression, exact size later confirmed with SetPartFinalLength.
byte	aFlag	JPEG flags.
ulong	aTimestampTickFrequency	Timestamp tick frequency. Can be used with JPEG2000 to turn buffer timestamp into real time units.
uint	aDataFormat	JPEG data format.

Returns

Type

Description

PvResult

Includes: #PvResult::Code::OK on success. #PvResult::Code::NOT_SUPPORTED if the PvBuffer accessed from this interfaced is not defined as a multi-part buffer. #PvResult::Code::ERR_OVERFLOW if the maximum number of parts supported by the GigE Vision specification has already been reached. #PvResult::Code::STATE_ERROR if the previously added part is of type chunk data which is only valid as the last part.

AllocAllParts()

Allocates memory for all parts defined by the part index of the multi-part container.

Declaration

public virtual PvResult AllocAllParts()

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::STATE_ERROR if no parts are currently defined. #PvResult::Code::ERR_OVERFLOW if more memory is required than currently supported by the PvBuffer class.

AllocPart(uint)

Allocates memory for one of the parts as defined by the index of the part.

Declaration

public virtual PvResult AllocPart(uint aIndex)

Parameters

Type	Name	Description
uint	aIndex	Zero-based index of the part.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER if aIndex is out of range.

AttachPart(uint, byte[], ulong)

Attaches a part to an external memory buffer.

Declaration

public virtual PvResult AttachPart(uint aIndex, byte[] aBuffer, ulong aLength)

Parameters

Type	Name	Description
uint	aIndex	Zero-based index of the part.
byte[]	aBuffer	Pointer to the external memory buffer.
ulong	aLength	Length of the external memory buffer to attach.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER if aIndex is out of range.

Dispose(bool)

Dispose

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Overrides

IPvMultiPartContainerReader.Dispose(bool)

Reset()

Resets the multi-part container index to empty - no parts.

Declaration

public virtual void Reset()

SetPartFinalImageHeight(uint, uint)

Sets the final height of an image part.

Declaration

public virtual PvResult SetPartFinalImageHeight(uint aIndex, uint aHeight)

Parameters

Type	Name	Description
uint	aIndex	Zero-based index of the part.
uint	aHeight	Final height of the part.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER if aIndex is out of range.

SetPartFinalLength(uint, uint)

Sets the final length of a part.

Declaration

public virtual PvResult SetPartFinalLength(uint aIndex, uint aLength)

Parameters

Type	Name	Description
uint	aIndex	Zero-based index of the part.
uint	aLength	aLength Final length of the part.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER if aIndex is out of range, aLength is bigger than the maximum part length or the part is an image.

SetPartIDs(uint, uint, uint, uint)

Sets the source, data purpose and region IDs of a part.

Declaration

public virtual PvResult SetPartIDs(uint aIndex, uint aSourceID, uint aDataPurposeID, uint aRegionID)

Parameters

Type	Name	Description
uint	aIndex	Zero-based index of the part.
uint	aSourceID	Source ID to assign to the part
uint	aDataPurposeID	Data purpose ID to assign to the part.
uint	aRegionID	Region ID to assign to the part.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_DATA_FORMAT if the indexed part is chunk data (which does not have these IDs defined) or if the buffer is not defined as multi-part. #PvResult::Code::INVALID_PARAMETER if aIndex is out of range.

SetPartZoneInfo(uint, byte, uint)

Sets the zone info of a part.

Declaration

public virtual PvResult SetPartZoneInfo(uint aIndex, byte aAdditionalZones, uint aZoneDirectionMask)

Parameters

Type	Name	Description
uint	aIndex	Zero-based index of the part.
byte	aAdditionalZones	Number of additional zones for this part.
uint	aZoneDirectionMask	Zone direction of for all zones of this part.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_DATA_FORMAT if the indexed part is chunk data (which does not have these IDs defined) or if the buffer is not defined as multi-part. #PvResult::Code::INVALID_PARAMETER if aIndex is out of range.

Validate()

Validates the part index and allocated/attached part memory.

Declaration

public virtual PvResult Validate()

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::INVALID_PARAMETER if aIndex is out of range.

Implements

IDisposable