Class VirtualParameter

Domain entity representing a Virtual Parameter.

Inheritance

System.Object

ParameterBase

VirtualParameter

Implements

IParameter

System.ComponentModel.INotifyPropertyChanged

Inherited Members

ParameterBase.Recalculate()

ParameterBase.NotifyPropertyChanged(String)

ParameterBase.ApplicationName

ParameterBase.Available

ParameterBase.BitShift

ParameterBase.ByteOrder

ParameterBase.CanRecalculate

ParameterBase.ConversionFunctionName

ParameterBase.DataBitMask

ParameterBase.Description

ParameterBase.ErrorBitmask

ParameterBase.FormatOverride

ParameterBase.GroupIdentifiers

ParameterBase.Identifier

ParameterBase.MaximumValue

ParameterBase.MinimumValue

ParameterBase.Name

ParameterBase.OffsetValue

ParameterBase.ShowInBrowser

ParameterBase.Unit

ParameterBase.UserType

ParameterBase.WarningMaximumValue

ParameterBase.WarningMinimumValue

ParameterBase.AvailabilityChanged

ParameterBase.PropertyChanged

Namespace: MESL.SqlRace.Domain

Assembly: MESL.SqlRace.Domain.dll

Syntax

public class VirtualParameter : ParameterBase, IParameter, INotifyPropertyChanged

Constructors

VirtualParameter(String, String, String, Double, Double, Double, Double, Double, String, UInt32, UInt32, String, LanguageType)

Initialises a new instance of the VirtualParameter class.

Declaration

public VirtualParameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, string conversionFunctionName, uint dataBitMask, uint errorBitMask, string functionCode, LanguageType languageType)

Parameters

Type	Name	Description
System.String	identifier	The identifier. The historic VIRT app group will be removed from the identifier i.e. 'param:VIRT' will be changed to 'param'.
System.String	name	The name of the virtual parameter.
System.String	description	The description.
System.Double	maximumValue	The maximum value.
System.Double	minimumValue	The minimum value.
System.Double	warningMaximumValue	The warning maximum value.
System.Double	warningMinimumValue	The warning minimum value.
System.Double	offsetValue	The offset value.
System.String	conversionFunctionName	Name of the conversion function.
System.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	functionCode	The function code.
LanguageType	languageType	Type of the language.

VirtualParameter(String, String, String, Double, Double, Double, Double, Double, String, UInt32, UInt32, String, LanguageType, List<String>)

Initialises a new instance of the VirtualParameter class.

Declaration

public VirtualParameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, string conversionFunctionName, uint dataBitMask, uint errorBitMask, string functionCode, LanguageType languageType, List<string> parameterGroupIdentifiers)

Parameters

Type	Name	Description
System.String	identifier	The identifier. The historic VIRT app group will be removed from the identifier i.e. 'param:VIRT' will be changed to 'param'.
System.String	name	The name of the virtual parameter.
System.String	description	The description.
System.Double	maximumValue	The maximum value.
System.Double	minimumValue	The minimum value.
System.Double	warningMaximumValue	The warning maximum value.
System.Double	warningMinimumValue	The warning minimum value.
System.Double	offsetValue	The offset value.
System.String	conversionFunctionName	Name of the conversion function.
System.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	functionCode	The function code.
LanguageType	languageType	Type of the language.
System.Collections.Generic.List<System.String>	parameterGroupIdentifiers	The parameter group identifiers.

VirtualParameter(String, String, String, Double, Double, Double, Double, Double, String, UInt32, UInt32, String, LanguageType, String)

Initialises a new instance of the VirtualParameter class.

Declaration

public VirtualParameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, string conversionFunctionName, uint dataBitMask, uint errorBitMask, string functionCode, LanguageType languageType, string applicationGroupName)

Parameters

Type	Name	Description
System.String	identifier	The identifier. The historic VIRT app group will be removed from the identifier i.e. 'param:VIRT' will be changed to 'param'.
System.String	name	The name of the virtual parameter.
System.String	description	The description.
System.Double	maximumValue	The maximum value.
System.Double	minimumValue	The minimum value.
System.Double	warningMaximumValue	The warning maximum value.
System.Double	warningMinimumValue	The warning minimum value.
System.Double	offsetValue	The offset value.
System.String	conversionFunctionName	Name of the conversion function.
System.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	functionCode	The function code.
LanguageType	languageType	Type of the language.
System.String	applicationGroupName	The application group name.

VirtualParameter(String, String, String, Double, Double, Double, Double, Double, String, UInt32, UInt32, String, LanguageType, String, List<String>)

Initialises a new instance of the VirtualParameter class.

Declaration

public VirtualParameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, string conversionFunctionName, uint dataBitMask, uint errorBitMask, string functionCode, LanguageType languageType, string applicationGroupName, List<string> parameterGroupIdentifiers)

Parameters

Type	Name	Description
System.String	identifier	The identifier. The historic VIRT app group will be removed from the identifier i.e. 'param:VIRT' will be changed to 'param'.
System.String	name	The name of the virtual parameter.
System.String	description	The description.
System.Double	maximumValue	The maximum value.
System.Double	minimumValue	The minimum value.
System.Double	warningMaximumValue	The warning maximum value.
System.Double	warningMinimumValue	The warning minimum value.
System.Double	offsetValue	The offset value.
System.String	conversionFunctionName	Name of the conversion function.
System.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	functionCode	The function code.
LanguageType	languageType	Type of the language.
System.String	applicationGroupName	The application group name.
System.Collections.Generic.List<System.String>	parameterGroupIdentifiers	The parameter group identifiers.

VirtualParameter(String, String, String, Double, Double, Double, Double, Double, String, UInt32, UInt32, String, LanguageType, String, List<String>, String, String)

Initialises a new instance of the VirtualParameter class.

Declaration

public VirtualParameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, string conversionFunctionName, uint dataBitMask, uint errorBitMask, string functionCode, LanguageType languageType, string applicationGroupName, List<string> parameterGroupIdentifiers, string formatOverride, string units)

Parameters

Type	Name	Description
System.String	identifier	The identifier. The historic VIRT app group will be removed from the identifier i.e. 'param:VIRT' will be changed to 'param'.
System.String	name	The name of the virtual parameter.
System.String	description	The description.
System.Double	maximumValue	The maximum value.
System.Double	minimumValue	The minimum value.
System.Double	warningMaximumValue	The warning maximum value.
System.Double	warningMinimumValue	The warning minimum value.
System.Double	offsetValue	The offset value.
System.String	conversionFunctionName	Name of the conversion function.
System.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	functionCode	The function code.
LanguageType	languageType	Type of the language.
System.String	applicationGroupName	The application group name.
System.Collections.Generic.List<System.String>	parameterGroupIdentifiers	The parameter group identifiers.
System.String	formatOverride	The format override.
System.String	units	The units value.

Fields

LegacyVirtSuffix

The app name formerly used for virtual parameters ":VIRT"

Declaration

public const string LegacyVirtSuffix = ":VIRT"

Field Value

Type	Description
System.String

Properties

FunctionCode

Gets the function code.

Declaration

public string FunctionCode { get; }

Property Value

Type	Description
System.String	The function code.

LanguageType

Gets the script language for the function within the VirtualParameter.

Declaration

public LanguageType LanguageType { get; }

Property Value

Type	Description
LanguageType	The type of the language.

ParameterType

Gets the type of the parameter.

Declaration

public override ParameterType ParameterType { get; }

Property Value

Type	Description
ParameterType	The type of the parameter.

Overrides

ParameterBase.ParameterType

Methods

ToString()

Returns a System.String that represents the current System.Object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents the current System.Object.

Overrides

ParameterBase.ToString()

Events

UnderlyingDataSourceChanged

Occurs when [underlying data source changed].

Declaration

public override event EventHandler UnderlyingDataSourceChanged

Event Type

Type	Description
System.EventHandler

Overrides

ParameterBase.UnderlyingDataSourceChanged

Implements

IParameter

System.ComponentModel.INotifyPropertyChanged