Class FamosFileComponent

A base class for a component, which is a full description of a single dataset.

Inheritance

System.Object

FamosFileBase

FamosFileBaseExtended

FamosFileComponent

FamosFileAnalogComponent

FamosFileDigitalComponent

Namespace: ImcFamosFile

Assembly: ImcFamosFile.dll

Syntax

public abstract class FamosFileComponent : FamosFileBaseExtended

Properties

BufferInfo

Gets or sets the buffer info containing a list of FamosFileBuffer.

Declaration

public FamosFileBufferInfo BufferInfo { get; set; }

Property Value

Type	Description
FamosFileBufferInfo

Channels

Gets a list of FamosFileChannel. In FAMOS, each channel is displayed individually and can be assigned to a group. For digital components, there should be one channel per bit.

Declaration

public List<FamosFileChannel> Channels { get; }

Property Value

Type	Description
System.Collections.Generic.List<FamosFileChannel>

DisplayInfo

Gets or sets the display info to describe how to display the data.

Declaration

public FamosFileDisplayInfo DisplayInfo { get; set; }

Property Value

Type	Description
FamosFileDisplayInfo

EventReference

Gets or sets the event reference containing a description of related events.

Declaration

public FamosFileEventReference EventReference { get; set; }

Property Value

Type	Description
FamosFileEventReference

Name

Gets the name of the first channel found in the channel list.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

PackInfo

Gets or sets the pack info containing a description of this components data layout.

Declaration

public FamosFilePackInfo PackInfo { get; set; }

Property Value

Type	Description
FamosFilePackInfo

TriggerTime

Gets or sets the trigger time of this component. If set, it will be applied to all subsequent components in the higher-level FamosFileField.

Declaration

public FamosFileTriggerTime TriggerTime { get; set; }

Property Value

Type	Description
FamosFileTriggerTime

Type

Gets the type of this component. Depending on the higher-level field type, the meaning varies between 'Y', 'Y of XY', 'real part', 'magnitude', 'magnitude in dB' and 'timestamp ASCII' for Primary and between 'X of XY', 'imaginary part' and 'phase' for Secondary.

Declaration

public FamosFileComponentType Type { get; }

Property Value

Type	Description
FamosFileComponentType

XAxisScaling

Gets or sets the x-axis scaling of this component. If set, it will be applied to all subsequent components in the higher-level FamosFileField.

Declaration

public FamosFileXAxisScaling XAxisScaling { get; set; }

Property Value

Type	Description
FamosFileXAxisScaling

ZAxisScaling

Gets or sets the z-axis scaling of this component. If set, it will be applied to all subsequent components in the higher-level FamosFileField.

Declaration

public FamosFileZAxisScaling ZAxisScaling { get; set; }

Property Value

Type	Description
FamosFileZAxisScaling

Methods

GetSize()

Calulates the size of this component depending on the values of BufferInfo and PackInfo.

Declaration

public int GetSize()

Returns

Type	Description
System.Int32	Returns the size of the component.

GetSize(Int32)

Calulates the size of this component depending on the values of BufferInfo and PackInfo.

Declaration

public int GetSize(int start)

Parameters

Type	Name	Description
System.Int32	start	The number of values to skip.

Returns

Type	Description
System.Int32	Returns the size of the component.

GetSize(Int32, Int32)

Calulates the size of this component depending on the values of BufferInfo and PackInfo.

Declaration

public int GetSize(int start, int length)

Parameters

Type	Name	Description
System.Int32	start	The number of values to skip.
System.Int32	length	The number of values to take.

Returns

Type	Description
System.Int32	Returns the size of the component.

Validate()

Validates the key status.

Declaration

public override void Validate()

Overrides

FamosFileBase.Validate()