Class IPvGenericDataComponent

One component in a GenDC container. A container can be formed by one or more components.

Inheritance

object

IPvGenericDataComponent

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

Remarks

Retrieve this via GetComponent(uint) or the [] indexer on IPvGenericDataContainer.

Each component groups related data parts. Access parts via GetPart(uint) or the [] indexer.

The pointer is owned by the container and remains valid as long as the containing IPvGenericDataContainer is alive.

Fields

swigCMemOwn

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

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

Flags

Flags property of IPvGenericDataComponent.

Declaration

public virtual ushort Flags { get; }

Property Value

Type	Description
ushort

Format

Format property of IPvGenericDataComponent.

Declaration

public virtual uint Format { get; }

Property Value

Type	Description
uint

GroupID

GroupID property of IPvGenericDataComponent.

Declaration

public virtual ushort GroupID { get; }

Property Value

Type	Description
ushort

HeaderSize

HeaderSize property of IPvGenericDataComponent.

Declaration

public virtual uint HeaderSize { get; }

Property Value

Type	Description
uint

this[uint]

Gets the part at the specified zero-based index.

Declaration

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

Parameters

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

Property Value

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

PartCount

PartCount property of IPvGenericDataComponent.

Declaration

public virtual uint PartCount { get; }

Property Value

Type	Description
uint

RegionID

RegionID property of IPvGenericDataComponent.

Declaration

public virtual ushort RegionID { get; }

Property Value

Type	Description
ushort

RegionOffsetX

RegionOffsetX property of IPvGenericDataComponent.

Declaration

public virtual uint RegionOffsetX { get; }

Property Value

Type	Description
uint

RegionOffsetY

RegionOffsetY property of IPvGenericDataComponent.

Declaration

public virtual uint RegionOffsetY { get; }

Property Value

Type	Description
uint

SourceID

SourceID property of IPvGenericDataComponent.

Declaration

public virtual ushort SourceID { get; }

Property Value

Type	Description
ushort

Timestamp

Timestamp property of IPvGenericDataComponent.

Declaration

public virtual ulong Timestamp { get; }

Property Value

Type	Description
ulong

TypeID

TypeID property of IPvGenericDataComponent.

Declaration

public virtual ulong TypeID { get; }

Property Value

Type	Description
ulong

TypeIDEnum

TypeIDEnum property of IPvGenericDataComponent.

Declaration

public virtual PvComponentType TypeIDEnum { get; }

Property Value

Type	Description
PvComponentType

Methods

AddPart(PvGenDCPartType, uint)

Creates a new part in the component.

Declaration

public virtual uint AddPart(PvGenDCPartType aPartType, uint aFlow)

Parameters

Type	Name	Description
PvGenDCPartType	aPartType	The type of part to create (e.g., PvGenDCPart2D, PvGenDCPartMetadataChunk).
uint	aFlow	The flow ID for this part.

Returns

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

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~IPvGenericDataComponent()

Destructor.

Declaration

protected ~IPvGenericDataComponent()

GetHeader()

Returns a const pointer to the underlying GenDC component header.

Declaration

public virtual GenDCComponentHeader GetHeader()

Returns

Type	Description
GenDCComponentHeader	Const pointer to the GenDC component header.

GetMutableHeader()

Returns a mutable pointer to the underlying GenDC component header.

Declaration

public virtual GenDCComponentHeader GetMutableHeader()

Returns

Type	Description
GenDCComponentHeader	Mutable pointer to the GenDC component header.

GetPart(uint)

Indexed part accessor.

Declaration

public virtual IPvGenericDataPart GetPart(uint aIndex)

Parameters

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

Returns

Type	Description
IPvGenericDataPart	Returns a part interface from its index.

GetPartHeaderOffset(uint)

Returns the data offset for the part associated with the index.

Declaration

public virtual ulong GetPartHeaderOffset(uint aIndex)

Parameters

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

Returns

Type	Description
ulong	Part header offset, in bytes.

Implements

IDisposable