Class IPvChunkData

Generic chunk data interface.

Inheritance

object

IPvChunkData

PvBuffer

PvChunkData

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

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 IPvChunkData.

Declaration

public virtual uint ChunkCount { get; }

Property Value

Type	Description
uint

ChunkDataCapacity

ChunkDataCapacity property of IPvChunkData.

Declaration

public virtual uint ChunkDataCapacity { get; }

Property Value

Type	Description
uint

ChunkDataSize

ChunkDataSize property of IPvChunkData.

Declaration

public virtual uint ChunkDataSize { get; }

Property Value

Type	Description
uint

ChunkLayoutID

ChunkLayoutID property of IPvChunkData.

Declaration

public virtual uint ChunkLayoutID { get; set; }

Property Value

Type	Description
uint

Methods

AddChunk(uint, byte[], uint)

See #PvBuffer::AddChunk.

Declaration

public virtual PvResult AddChunk(uint aID, byte[] aData, uint aLength)

Parameters

Type	Name	Description
uint	aID	Chunk data ID for aIndex.
byte[]	aData	Payload data of the chunk data.
uint	aLength	Length of the payload data of the chunk, in bytes. Must be a multiple of 4 bytes.

Returns

Type	Description
PvResult	A PvResult is used to capture the success or failure of the operation: #PvResult::Code::OK #PvResult::Code::BUFFER_TOO_SMALL There is not enough space in the buffer to add the chunk data. #PvResult::Code::INVALID_PARAMETER One of the input arguments is invalid.

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~IPvChunkData()

Destructor.

Declaration

protected ~IPvChunkData()

GetChunkIDByIndex(uint, out uint)

See #PvBuffer::GetChunkIDByIndex.

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	A PvResult is used to captured the success or failure of the operation as 0 can be a valid chunk ID: #PvResult::Code::OK #PvResult::Code::NOT_FOUND if the index is out of range or the buffer does not have any chunks

GetChunkRawDataByID(uint)

See #PvBuffer::GetChunkRawDataByID.

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)

See #PvBuffer::GetChunkRawDataByIndex.

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)

See #PvBuffer::GetChunkSizeByID.

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)

See #PvBuffer::GetChunkSizeByIndex.

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.

HasChunks()

Returns true if the buffer has data chunks.

Declaration

public virtual bool HasChunks()

Returns

Type	Description
bool	True if the buffer holds data chunks, false if not.

ResetChunks()

See #PvBuffer::ResetChunks

Declaration

public virtual void ResetChunks()

Implements

IDisposable