Class GenDCContainerHeaderBase

Base fields of a GenDC container header, as defined by the GenDC 1.1 specification.

Inheritance

object

GenDCContainerHeaderBase

GenDCContainerHeader

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

Constructors

GenDCContainerHeaderBase()

Declaration

public GenDCContainerHeaderBase()

Fields

swigCMemOwn

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

ComponentCount

Number of components in this container.

Declaration

public uint ComponentCount { get; set; }

Property Value

Type	Description
uint

DataOffset

Offset from the start of the container to the first data byte.

Declaration

public long DataOffset { get; set; }

Property Value

Type	Description
long

DataSize

Total size of all component data payloads in bytes.

Declaration

public ulong DataSize { get; set; }

Property Value

Type	Description
ulong

DescriptorSize

Size of the full GenDC descriptor (header + component headers + part headers) in bytes.

Declaration

public uint DescriptorSize { get; set; }

Property Value

Type	Description
uint

Flags

Container-level flags (e.g. PTP timestamp, component invalid).

Declaration

public GenDCContainerFlagsGroup Flags { get; set; }

Property Value

Type	Description
GenDCContainerFlagsGroup

HeaderSize

Total size of the container descriptor in bytes.

Declaration

public uint HeaderSize { get; set; }

Property Value

Type	Description
uint

HeaderType

Header type identifier. Always GenDCHeaderType::TypeContainer for container headers.

Declaration

public GenDCHeaderType HeaderType { get; set; }

Property Value

Type	Description
GenDCHeaderType

Id

Unique identifier for this container.

Declaration

public ulong Id { get; set; }

Property Value

Type	Description
ulong

Reserved

Reserved for alignment and future use.

Declaration

public byte Reserved { get; set; }

Property Value

Type	Description
byte

Reserved16

Reserved for alignment.

Declaration

public ushort Reserved16 { get; set; }

Property Value

Type	Description
ushort

Reserved32

Reserved for future use.

Declaration

public uint Reserved32 { get; set; }

Property Value

Type	Description
uint

Signature

GenDC signature. Must be 0x43444E47 ("GNDC").

Declaration

public GenDCSignature Signature { get; set; }

Property Value

Type	Description
GenDCSignature

VariableFields

Bitmask indicating which descriptor fields may vary between acquisitions.

Declaration

public GenDCContainerVariableFieldsGroup VariableFields { get; set; }

Property Value

Type	Description
GenDCContainerVariableFieldsGroup

VersionMajor

Major version of the GenDC specification used.

Declaration

public byte VersionMajor { get; set; }

Property Value

Type	Description
byte

VersionMinor

Minor version of the GenDC specification used.

Declaration

public byte VersionMinor { get; set; }

Property Value

Type	Description
byte

VersionSubMinor

Subminor version of the GenDC specification used.

Declaration

public byte VersionSubMinor { get; set; }

Property Value

Type	Description
byte

Methods

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~GenDCContainerHeaderBase()

Destructor.

Declaration

protected ~GenDCContainerHeaderBase()

Implements

IDisposable