Class VirtualParameter

Holds the information about the virtual parameters. Virtual parameters may be combined using functions to give derived results. The output of a Function can be manipulated and displayed in the same way as a Parameter.

Inheritance

System.Object

VirtualParameter

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: MAT.AtlasSessionApi

Assembly: MAT.AtlasSessionApi.dll

Syntax

public class VirtualParameter

Constructors

VirtualParameter(String, String, String, String, String, String, IEnumerable<String>, Range, Range, Double)

A new instance of the parameter.

Declaration

public VirtualParameter(string identifier, string name, string description, string format, string formula, string conversionId, IEnumerable<string> subGroups, Range physicalRange, Range warningRange, double offset)

Parameters

Type	Name	Description
System.String	identifier	Parameter identifier.
System.String	name	Parameter name.
System.String	description	Parameter description.
System.String	format	format of the parameter.
System.String	formula	Formula for the calculation.
System.String	conversionId	Conversion identifier.
System.Collections.Generic.IEnumerable<System.String>	subGroups	List of sub groups.
Range	physicalRange	Upper and lower limit of the parameter.
Range	warningRange	Upper and lower warning limit of the parameter.
System.Double	offset	Offset value.

Exceptions

Type	Condition
System.ArgumentNullException	Exception for null input.
System.ArgumentException	Exception for empty input.

Properties

ConversionId

Gets the conversion identifier.

Declaration

public string ConversionId { get; }

Property Value

Type	Description
System.String

Description

Gets the parameter description.

Declaration

public string Description { get; }

Property Value

Type	Description
System.String

Format

Gets the format of the parameter.

Declaration

public string Format { get; }

Property Value

Type	Description
System.String

Formula

Gets the formula of the parameter.

Declaration

public string Formula { get; }

Property Value

Type	Description
System.String

Identifier

Gets the parameter identifier.

Declaration

public string Identifier { get; }

Property Value

Type	Description
System.String

Name

Gets the name of the parameter.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

Offset

Gets the offset value.

Declaration

public double Offset { get; }

Property Value

Type	Description
System.Double

PhysicalRange

Gets the physical range.

Declaration

public Range PhysicalRange { get; }

Property Value

Type	Description
Range

SubGroups

Gets the sub groups of the parameter.

Declaration

public IReadOnlyList<string> SubGroups { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<System.String>

WarningRange

Gets the warning range.

Declaration

public Range WarningRange { get; }

Property Value

Type	Description
Range

Methods

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

Operators

Equality(VirtualParameter, VirtualParameter)

Are two parameters equal?

Declaration

public static bool operator ==(VirtualParameter left, VirtualParameter right)

Parameters

Type	Name	Description
VirtualParameter	left	parameter object 1
VirtualParameter	right	parameter object 2

Returns

Type	Description
System.Boolean

Inequality(VirtualParameter, VirtualParameter)

Are two parameters unequal?

Declaration

public static bool operator !=(VirtualParameter left, VirtualParameter right)

Parameters

Type	Name	Description
VirtualParameter	left	parameter object 1
VirtualParameter	right	parameter object 2

Returns

Type	Description
System.Boolean