Class IPvGenDCChunkData

Generic chunk data interface for GenDC parts.

Inheritance

object

IPvGenDCChunkData

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

Remarks

Retrieve this interface via GetGenDCChunkData() when the part header type is a metadata chunk type (e.g. PvGenDCPartMetadataGenICamChunk).

The pointer is owned by the part and remains valid as long as the containing IPvGenericDataPart is alive.

Fields

swigCMemOwn

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

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

ChunkCount

ChunkCount property of IPvGenDCChunkData.

Declaration

public virtual uint ChunkCount { get; }

Property Value

Type	Description
uint

ChunkLayoutID

ChunkLayoutID property of IPvGenDCChunkData.

Declaration

public virtual uint ChunkLayoutID { get; }

Property Value

Type	Description
uint

HasChunks

HasChunks property of IPvGenDCChunkData.

Declaration

public virtual bool HasChunks { get; }

Property Value

Type	Description
bool

Methods

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~IPvGenDCChunkData()

Destructor.

Declaration

protected ~IPvGenDCChunkData()

GetChunkIDByIndex(uint, out uint)

Get chunk ID by index.

Declaration

public virtual PvResult GetChunkIDByIndex(uint aIndex, out uint aID)

Parameters

Type	Name	Description
uint	aIndex	Data chunk index.
uint	aID	Data chunk ID for aIndex.

Returns

Type	Description
PvResult	Includes: - #PvResult::Code::OK #PvResult::Code::NOT_FOUND if the index is out of range

GetChunkRawDataByID(uint)

Get chunk raw data by ID.

Declaration

public virtual byte* GetChunkRawDataByID(uint aID)

Parameters

Type	Name	Description
uint	aID	Data chunk ID.

Returns

Type	Description
byte*	Pointer to chunk data. NULL if the chunk ID is not found.

GetChunkRawDataByIndex(uint)

Get chunk raw data by index.

Declaration

public virtual byte* GetChunkRawDataByIndex(uint aIndex)

Parameters

Type	Name	Description
uint	aIndex	Data chunk index.

Returns

Type	Description
byte*	Pointer to chunk data. NULL if the index is out of range.

GetChunkSizeByID(uint)

Get chunk size by ID.

Declaration

public virtual uint GetChunkSizeByID(uint aID)

Parameters

Type	Name	Description
uint	aID	Data chunk ID.

Returns

Type	Description
uint	Data chunk size. 0 if the chunk ID is not found.

GetChunkSizeByIndex(uint)

Get chunk size by index.

Declaration

public virtual uint GetChunkSizeByIndex(uint aIndex)

Parameters

Type	Name	Description
uint	aIndex	Data chunk index.

Returns

Type	Description
uint	Data chunk size. 0 if the index is out of range.

Implements

IDisposable