Class FamosFileField

A field is a collection of components, e.g. to represent X and Y data of a measurement.

Inheritance
System.Object
FamosFileBase
FamosFileBaseExtended
FamosFileField
Namespace: ImcFamosFile
Assembly: ImcFamosFile.dll
Syntax
public class FamosFileField : FamosFileBaseExtended

Constructors

| Improve this Doc View Source

FamosFileField()

Initializes a new instance of the FamosFileField class.

Declaration
public FamosFileField()
| Improve this Doc View Source

FamosFileField(FamosFileFieldType)

Initializes a new instance of the FamosFileField class.

Declaration
public FamosFileField(FamosFileFieldType type)
Parameters
Type Name Description
FamosFileFieldType type

The type of the field.
| Improve this Doc View Source

FamosFileField(FamosFileFieldType, List<FamosFileComponent>)

Initializes a new instance of the FamosFileField class.

Declaration
public FamosFileField(FamosFileFieldType type, List<FamosFileComponent> components)
Parameters
Type Name Description
FamosFileFieldType type

The type of the field.
System.Collections.Generic.List<FamosFileComponent> components

A list of components belonging to the field.

Properties

| Improve this Doc View Source

Components

Gets a list of components.

Declaration
public List<FamosFileComponent> Components { get; }
Property Value
Type Description
System.Collections.Generic.List<FamosFileComponent>
| Improve this Doc View Source

Dimension

Gets number of dimensions.

Declaration
public int Dimension { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

EventInfos

Gets a list of event infos.

Declaration
public List<FamosFileEventInfo> EventInfos { get; }
Property Value
Type Description
System.Collections.Generic.List<FamosFileEventInfo>
| Improve this Doc View Source

TriggerTime

Gets or sets the trigger time. If set, it will be applied to all components unless redefined by a component.

Declaration
public FamosFileTriggerTime TriggerTime { get; set; }
Property Value
Type Description
FamosFileTriggerTime
| Improve this Doc View Source

Type

Gets or sets the type of the field. Default is MultipleYToSingleEquidistantTime.

Declaration
public FamosFileFieldType Type { get; set; }
Property Value
Type Description
FamosFileFieldType
| Improve this Doc View Source

XAxisScaling

Gets or sets the x-axis scaling. If set, it will be applied to all components unless redefined by a component.

Declaration
public FamosFileXAxisScaling XAxisScaling { get; set; }
Property Value
Type Description
FamosFileXAxisScaling
| Improve this Doc View Source

ZAxisScaling

Gets or sets the z-axis scaling. If set, it will be applied to all components unless redefined by a component.

Declaration
public FamosFileZAxisScaling ZAxisScaling { get; set; }
Property Value
Type Description
FamosFileZAxisScaling

Methods

| Improve this Doc View Source

GetChannels()

Gets all channels that are part of the components belonging to this instance.

Declaration
public List<FamosFileChannel> GetChannels()
Returns
Type Description
System.Collections.Generic.List<FamosFileChannel>

Returns a list of FamosFileChannel.
| Improve this Doc View Source

Validate()

Validates the key status.

Declaration
public override void Validate()
Overrides