Class IPvGenericDataPart

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

Inheritance

object

IPvGenericDataPart

Implements

IDisposable

Inherited Members

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 IPvGenericDataPart : IDisposable

Remarks

Retrieve this via GetPart(uint) or the [] indexer on IPvGenericDataComponent.

Use GetGenDCImage() to get image-specific data when the part is a 2D type, or GetGenDCChunkData() for chunk metadata parts.

The pointer is owned by the component and remains valid as long as the containing IPvGenericDataComponent is alive.

Fields

swigCMemOwn

Determines who is responsible for deleting the underlying C++ object.

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

DataOffset

DataOffset property of IPvGenericDataPart.

Declaration

public virtual ulong DataOffset { get; }

Property Value

Type	Description
ulong

DataSize

DataSize property of IPvGenericDataPart.

Declaration

public virtual ulong DataSize { get; }

Property Value

Type	Description
ulong

Flags

Flags property of IPvGenericDataPart.

Declaration

public virtual ushort Flags { get; }

Property Value

Type	Description
ushort

FlowID

FlowID property of IPvGenericDataPart.

Declaration

public virtual ushort FlowID { get; }

Property Value

Type	Description
ushort

FlowOffset

FlowOffset property of IPvGenericDataPart.

Declaration

public virtual ulong FlowOffset { get; }

Property Value

Type	Description
ulong

Format

Format property of IPvGenericDataPart.

Declaration

public virtual uint Format { get; }

Property Value

Type	Description
uint

HeaderSize

HeaderSize property of IPvGenericDataPart.

Declaration

public virtual uint HeaderSize { get; }

Property Value

Type	Description
uint

HeaderType

HeaderType property of IPvGenericDataPart.

Declaration

public virtual ushort HeaderType { get; }

Property Value

Type	Description
ushort

HeaderTypeEnum

HeaderTypeEnum property of IPvGenericDataPart.

Declaration

public virtual PvGenDCPartType HeaderTypeEnum { get; }

Property Value

Type	Description
PvGenDCPartType

ReceptionTime

ReceptionTime property of IPvGenericDataPart.

Declaration

public virtual ulong ReceptionTime { get; }

Property Value

Type	Description
ulong

Methods

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~IPvGenericDataPart()

Destructor.

Declaration

protected ~IPvGenericDataPart()

Get1DHeader()

Returns the part header cast to a GenDCPartHeader1D pointer. Only valid when HeaderTypeEnum is PvGenDCPart1D.

Declaration

public virtual GenDCPartHeader1D Get1DHeader()

Returns

Type	Description
GenDCPartHeader1D	A pointer to a GenDCPartHeader1D header.

Get1DSpecificFields(PvGenDCPart1DFields)

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

Declaration

public virtual PvResult Get1DSpecificFields(PvGenDCPart1DFields aSpecificFields)

Parameters

Type	Name	Description
PvGenDCPart1DFields	aSpecificFields	Output parameter to receive the 1D-specific fields.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::NOT_SUPPORTED if the header type is not 1D.

Get2DHeader()

Returns the part header cast to a GenDCPartHeader2D pointer. Only valid when HeaderTypeEnum is PvGenDCPart2D.

Declaration

public virtual GenDCPartHeader2D Get2DHeader()

Returns

Type	Description
GenDCPartHeader2D	A pointer to a GenDCPartHeader2D header.

Get2DSpecificFields(PvGenDCPart2DFields)

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

Declaration

public virtual PvResult Get2DSpecificFields(PvGenDCPart2DFields aSpecificFields)

Parameters

Type	Name	Description
PvGenDCPart2DFields	aSpecificFields	Output parameter to receive the 2D-specific fields.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::NOT_SUPPORTED if the header type is not 2D.

GetDataPointer()

Returns the part's data pointer.

Declaration

public virtual byte* GetDataPointer()

Returns

Type	Description
byte*	A pointer to the memory pointer.

GetGenDCChunkData()

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

Declaration

public virtual IPvGenDCChunkData GetGenDCChunkData()

Returns

Type	Description
IPvGenDCChunkData	IPvGenDCChunkData interface to the part.

GetGenDCChunkWriter()

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

Declaration

public virtual IPvGenDCChunkWriter GetGenDCChunkWriter()

Returns

Type	Description
IPvGenDCChunkWriter	IPvGenDCChunkWriter interface to the part.

GetGenDCImage()

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

Declaration

public virtual IPvGenDCImage GetGenDCImage()

Returns

Type	Description
IPvGenDCImage	IPvGenDCImage interface to the part.

GetGenICamChunkHeader()

Returns the part header cast to a GenDCPartHeaderGenICamChunk pointer. Only valid when HeaderTypeEnum is PvGenDCPartMetadataGenICamChunk.

Declaration

public virtual GenDCPartHeaderGenICamChunk GetGenICamChunkHeader()

Returns

Type	Description
GenDCPartHeaderGenICamChunk	A pointer to a GenDCPartHeaderGenICamChunk header.

GetGenICamXMLHeader()

Returns the part header cast to a GenDCPartHeaderGenICamXML pointer. Only valid when HeaderTypeEnum is PvGenDCPartMetadataGenICamXML.

Declaration

public virtual GenDCPartHeaderGenICamXML GetGenICamXMLHeader()

Returns

Type	Description
GenDCPartHeaderGenICamXML	A pointer to a GenDCPartHeaderGenICamXML header.

GetH264Header()

Returns the part header cast to a GenDCPartHeaderH264 pointer. Only valid when HeaderTypeEnum is PvGenDCPart2DH264.

Declaration

public virtual GenDCPartHeaderH264 GetH264Header()

Returns

Type	Description
GenDCPartHeaderH264	A pointer to a GenDCPartHeaderH264 header.

GetH264SpecificFields(PvGenDCPartH264Fields)

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

Declaration

public virtual PvResult GetH264SpecificFields(PvGenDCPartH264Fields aSpecificFields)

Parameters

Type	Name	Description
PvGenDCPartH264Fields	aSpecificFields	Output parameter to receive the H.264-specific fields.

Returns

Type	Description
PvResult	PV_OK on success, or PV_NOT_SUPPORTED if not an H.264 type.

GetHeader()

Returns a const pointer to the underlying GenDC part header.

Declaration

public virtual GenDCPartHeader GetHeader()

Returns

Type	Description
GenDCPartHeader	Const pointer to the GenDC part header.

GetJPEG2000Header()

Returns the part header cast to a GenDCPartHeaderJPEG2000 pointer. Only valid when HeaderTypeEnum is PvGenDCPart2DJpeg2000.

Declaration

public virtual GenDCPartHeaderJPEG2000 GetJPEG2000Header()

Returns

Type	Description
GenDCPartHeaderJPEG2000	A pointer to a GenDCPartHeaderJPEG2000 header.

GetJPEGHeader()

Returns the part header cast to a GenDCPartHeaderJPEG pointer. Only valid when HeaderTypeEnum is PvGenDCPart2DJpeg.

Declaration

public virtual GenDCPartHeaderJPEG GetJPEGHeader()

Returns

Type	Description
GenDCPartHeaderJPEG	A pointer to a GenDCPartHeaderJPEG header.

GetMetadataSpecificFields(PvGenDCPartMetadataFields)

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

Declaration

public virtual PvResult GetMetadataSpecificFields(PvGenDCPartMetadataFields aMetadataFields)

Parameters

Type	Name	Description
PvGenDCPartMetadataFields	aMetadataFields	Output parameter to receive the metadata-specific fields.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK on success. #PvResult::Code::NOT_SUPPORTED if the header type is not metadata.

GetMutableHeader()

Returns a mutable pointer to the underlying GenDC part header.

Declaration

public virtual GenDCPartHeader GetMutableHeader()

Returns

Type	Description
GenDCPartHeader	Mutable pointer to the GenDC part header.

Implements

IDisposable