Class GenDCComponentHeaderBase

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

Inheritance

object

GenDCComponentHeaderBase

GenDCComponentHeader

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

Constructors

GenDCComponentHeaderBase()

Declaration

public GenDCComponentHeaderBase()

Fields

swigCMemOwn

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

Flags

Component-level flags (e.g. invalid).

Declaration

public GenDCComponentFlagsGroup Flags { get; set; }

Property Value

Type	Description
GenDCComponentFlagsGroup

Format

Pixel format of the component data. See PvPixelType.

Declaration

public PvPixelType Format { get; set; }

Property Value

Type	Description
PvPixelType

GroupId

Group identifier linking related components across containers.

Declaration

public ushort GroupId { get; set; }

Property Value

Type	Description
ushort

HeaderSize

Total size of this component header in bytes.

Declaration

public uint HeaderSize { get; set; }

Property Value

Type	Description
uint

HeaderType

Header type identifier. Always GenDCHeaderType::TypeComponent for component headers.

Declaration

public GenDCHeaderType HeaderType { get; set; }

Property Value

Type	Description
GenDCHeaderType

PartCount

Number of parts in this component.

Declaration

public ushort PartCount { get; set; }

Property Value

Type	Description
ushort

RegionId

Region of interest identifier.

Declaration

public ushort RegionId { get; set; }

Property Value

Type	Description
ushort

RegionOffsetX

Horizontal offset of the region of interest in pixels.

Declaration

public uint RegionOffsetX { get; set; }

Property Value

Type	Description
uint

RegionOffsetY

Vertical offset of the region of interest in pixels.

Declaration

public uint RegionOffsetY { get; set; }

Property Value

Type	Description
uint

Reserved

Reserved for alignment.

Declaration

public ushort Reserved { get; set; }

Property Value

Type	Description
ushort

Reserved2

Reserved for alignment.

Declaration

public ushort Reserved2 { get; set; }

Property Value

Type	Description
ushort

SourceId

Source identifier indicating the image sensor or data source.

Declaration

public ushort SourceId { get; set; }

Property Value

Type	Description
ushort

Timestamp

Acquisition timestamp in nanoseconds.

Declaration

public long Timestamp { get; set; }

Property Value

Type	Description
long

TypeId

Component type identifier (e.g. Intensity, Range). See GenDCComponentType.

Declaration

public ulong TypeId { get; set; }

Property Value

Type	Description
ulong

Methods

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~GenDCComponentHeaderBase()

Destructor.

Declaration

protected ~GenDCComponentHeaderBase()

Implements

IDisposable