Class IPvGenericDataContainer

Interface used to read from a GenDC container.

Inheritance

object

IPvGenericDataContainer

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

Remarks

Obtain this interface from a received PvBuffer via GetGenDC() when the buffer's PayloadType is PvPayloadTypeGenDC.

Each container holds one or more components accessible via GetComponent(uint) or the [] indexer. Each component in turn holds one or more parts accessible via GetPart(uint).

The pointer is owned by the PvBuffer and remains valid as long as the PvBuffer is alive.

Fields

swigCMemOwn

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

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

ComponentCount

ComponentCount property of IPvGenericDataContainer.

Declaration

public virtual uint ComponentCount { get; }

Property Value

Type	Description
uint

DataSize

DataSize property of IPvGenericDataContainer.

Declaration

public virtual ulong DataSize { get; }

Property Value

Type	Description
ulong

DescriptorSize

DescriptorSize property of IPvGenericDataContainer.

Declaration

public virtual ulong DescriptorSize { get; }

Property Value

Type	Description
ulong

IsValid

IsValid property of IPvGenericDataContainer.

Declaration

public virtual bool IsValid { get; }

Property Value

Type	Description
bool

this[uint]

Gets the component at the specified zero-based index.

Declaration

public virtual IPvGenericDataComponent this[uint aIndex] { get; set; }

Parameters

Type	Name	Description
uint	aIndex	Zero-based index of the component to retrieve.

Property Value

Type	Description
IPvGenericDataComponent	The IPvGenericDataComponent at the specified index, or null if not found.

Methods

AddComponent(PvComponentType)

Creates a new component in the container.

Declaration

public virtual uint AddComponent(PvComponentType aComponentType)

Parameters

Type	Name	Description
PvComponentType	aComponentType	The type of component to create (e.g., PvComponentIntensity, PvComponentRange).

Returns

Type	Description
uint	The zero-based index of the newly created component.

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~IPvGenericDataContainer()

Destructor.

Declaration

protected ~IPvGenericDataContainer()

GetComponent(uint)

Indexed component accessor.

Declaration

public virtual IPvGenericDataComponent GetComponent(uint aIndex)

Parameters

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

Returns

Type	Description
IPvGenericDataComponent	Returns a component interface from its index.

GetHeader()

Returns a const pointer to the underlying GenDC container header.

Declaration

public virtual GenDCContainerHeader GetHeader()

Returns

Type	Description
GenDCContainerHeader	Const pointer to the GenDC container header.

GetMutableHeader()

Returns a mutable pointer to the underlying GenDC container header.

Declaration

public virtual GenDCContainerHeader GetMutableHeader()

Returns

Type	Description
GenDCContainerHeader	Mutable pointer to the GenDC container header.

Implements

IDisposable