Class Parameter

Represents a Parameter.

Inheritance

System.Object

ParameterBase

ChannelBasedParameter

Parameter

Implements

IParameter

System.ComponentModel.INotifyPropertyChanged

Inherited Members

ChannelBasedParameter.AddChannel(IChannel)

ChannelBasedParameter.ApplyChannelOffset(UInt32)

ChannelBasedParameter.MergeChannelIds(IReadOnlyCollection<UInt32>)

ChannelBasedParameter.MergeChannels(IReadOnlyCollection<IChannel>)

ChannelBasedParameter.SetChannels(IReadOnlyCollection<IChannel>)

ChannelBasedParameter.ChannelIds

ChannelBasedParameter.Channels

ChannelBasedParameter.InMemory

ChannelBasedParameter.ParameterChannelKey

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 Parameter : ChannelBasedParameter, IChannelBasedParameter, IParameter, INotifyPropertyChanged

Remarks

Parameters are physical properties that are measured during a session and contain one or more Channel where the underlying data is stored. Each parameter has a set of properties which can be used to control how a parameter is displayed. Parameters can also be organised into ParameterGroupgroups

.

Parameters can be added to a configuration set using the ConfigurationSetManager or added to the specific session using the CreateConfiguration() method.

The list of parameters for a session can be retrieved using the Parameters collection.

Parameters are used in combination with the ParameterDataAccess class to read data from the SQL Race API.

Constructors

Parameter(String, String, String, Double, Double, Double, Double, Double, UInt32, UInt32, String, List<String>, List<UInt32>)

Initialises a new instance of the Parameter class.

Declaration

public Parameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, uint dataBitMask, uint errorBitMask, string conversionFunctionName, List<string> parameterGroupIdentifiers, List<uint> channelIds)

Parameters

Type	Name	Description
System.String	identifier	The identifier.
System.String	name	The name of 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.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	conversionFunctionName	The conversion function.
System.Collections.Generic.List<System.String>	parameterGroupIdentifiers	The parameter group identifiers.
System.Collections.Generic.List<System.UInt32>	channelIds	The channel ids.

Exceptions

Type	Condition
System.ArgumentException	Thrown when an attempt is made to add multiple channels with the same interval. Also thrown is null is passed for the channel list.

Parameter(String, String, String, Double, Double, Double, Double, Double, UInt32, UInt32, String, List<String>, List<UInt32>, String)

Initialises a new instance of the Parameter class.

Declaration

public Parameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, uint dataBitMask, uint errorBitMask, string conversionFunctionName, List<string> parameterGroupIdentifiers, List<uint> channelIds, string applicationName)

Parameters

Type	Name	Description
System.String	identifier	The identifier.
System.String	name	The name of the 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.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	conversionFunctionName	Name of the conversion function.
System.Collections.Generic.List<System.String>	parameterGroupIdentifiers	The parameter group identifiers.
System.Collections.Generic.List<System.UInt32>	channelIds	The channel ids.
System.String	applicationName	Name of the application.

Parameter(String, String, String, Double, Double, Double, Double, Double, UInt32, UInt32, String, List<String>, List<UInt32>, String, String)

Initialises a new instance of the Parameter class.

Declaration

public Parameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, uint dataBitMask, uint errorBitMask, string conversionFunctionName, List<string> parameterGroupIdentifiers, List<uint> channelIds, string applicationName, string formatOverride)

Parameters

Type	Name	Description
System.String	identifier	The identifier.
System.String	name	The name of the 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.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	conversionFunctionName	Name of the conversion function.
System.Collections.Generic.List<System.String>	parameterGroupIdentifiers	The parameter group identifiers.
System.Collections.Generic.List<System.UInt32>	channelIds	The channel ids.
System.String	applicationName	Name of the application.
System.String	formatOverride	The format override.

Parameter(String, String, String, Double, Double, Double, Double, Double, UInt32, UInt32, String, List<String>, List<UInt32>, String, String, String)

Initialises a new instance of the Parameter class.

Declaration

public Parameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, uint dataBitMask, uint errorBitMask, string conversionFunctionName, List<string> parameterGroupIdentifiers, List<uint> channelIds, string applicationName, string formatOverride, string units)

Parameters

Type	Name	Description
System.String	identifier	The identifier.
System.String	name	The name of the 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.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	conversionFunctionName	Name of the conversion function.
System.Collections.Generic.List<System.String>	parameterGroupIdentifiers	The parameter group identifiers.
System.Collections.Generic.List<System.UInt32>	channelIds	The channel ids.
System.String	applicationName	Name of the application.
System.String	formatOverride	The format override.
System.String	units	The units value.

Parameter(String, String, String, Double, Double, Double, Double, Double, UInt32, UInt32, String, List<String>, String, String)

Initialises a new instance of the Parameter class.

Declaration

public Parameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, uint dataBitMask, uint errorBitMask, string conversionFunctionName, List<string> parameterGroupIdentifiers, string parameterChannelKey, string applicationName)

Parameters

Type	Name	Description
System.String	identifier	The identifier.
System.String	name	The parameter name.
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.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	conversionFunctionName	Name of the conversion function.
System.Collections.Generic.List<System.String>	parameterGroupIdentifiers	The parameter group identifiers.
System.String	parameterChannelKey	The parameter channel key, used for linking associated parameters and their channels when during end configuration.
System.String	applicationName	Name of the application group.

Parameter(String, String, String, Double, Double, Double, Double, Double, UInt32, UInt32, String, List<String>, String, String, String)

Initialises a new instance of the Parameter class.

Declaration

public Parameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, uint dataBitMask, uint errorBitMask, string conversionFunctionName, List<string> parameterGroupIdentifiers, string parameterChannelKey, string applicationName, string formatOverride)

Parameters

Type	Name	Description
System.String	identifier	The identifier.
System.String	name	The parameter name.
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.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	conversionFunctionName	Name of the conversion function.
System.Collections.Generic.List<System.String>	parameterGroupIdentifiers	The parameter group identifiers.
System.String	parameterChannelKey	The parameter channel key, used for linking associated parameters and their channels when during end configuration.
System.String	applicationName	Name of the application group.
System.String	formatOverride	The format override.

Parameter(String, String, String, Double, Double, Double, Double, Double, UInt32, UInt32, String, List<String>, String, String, String, String)

Initialises a new instance of the Parameter class.

Declaration

public Parameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, uint dataBitMask, uint errorBitMask, string conversionFunctionName, List<string> parameterGroupIdentifiers, string parameterChannelKey, string applicationName, string formatOverride, string units)

Parameters

Type	Name	Description
System.String	identifier	The identifier.
System.String	name	The parameter name.
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.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	conversionFunctionName	Name of the conversion function.
System.Collections.Generic.List<System.String>	parameterGroupIdentifiers	The parameter group identifiers.
System.String	parameterChannelKey	The parameter channel key, used for linking associated parameters and their channels when during end configuration.
System.String	applicationName	Name of the application group.
System.String	formatOverride	The format override.
System.String	units	The units value.

Parameter(String, String, String, Double, Double, Double, Double, Double, UInt32, UInt32, String, List<String>, UInt32)

Initialises a new instance of the Parameter class.

Declaration

public Parameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, uint dataBitMask, uint errorBitMask, string conversionFunctionName, List<string> parameterGroupIdentifiers, uint channelId)

Parameters

Type	Name	Description
System.String	identifier	The identifier.
System.String	name	The name of the 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.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	conversionFunctionName	The conversion function.
System.Collections.Generic.List<System.String>	parameterGroupIdentifiers	The parameter group identifiers.
System.UInt32	channelId	The channel id.

Parameter(String, String, String, Double, Double, Double, Double, Double, UInt32, UInt32, String, List<String>, UInt32, String)

Initialises a new instance of the Parameter class.

Declaration

public Parameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, uint dataBitMask, uint errorBitMask, string conversionFunctionName, List<string> parameterGroupIdentifiers, uint channelId, string applicationName)

Parameters

Type	Name	Description
System.String	identifier	The identifier.
System.String	name	The parameter name.
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.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	conversionFunctionName	Name of the conversion function.
System.Collections.Generic.List<System.String>	parameterGroupIdentifiers	The parameter group identifiers.
System.UInt32	channelId	The channel id.
System.String	applicationName	Name of the application group.

Parameter(String, String, String, Double, Double, Double, Double, Double, UInt32, UInt32, String, List<UInt32>)

Initialises a new instance of the Parameter class.

Declaration

public Parameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, uint dataBitMask, uint errorBitMask, string conversionFunctionName, List<uint> channelIds)

Parameters

Type	Name	Description
System.String	identifier	The identifier.
System.String	name	The name of the 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.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	conversionFunctionName	The conversion function.
System.Collections.Generic.List<System.UInt32>	channelIds	The channel ids.

Parameter(String, String, String, Double, Double, Double, Double, Double, UInt32, UInt32, String, String)

Initialises a new instance of the Parameter class.

Declaration

public Parameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, uint dataBitMask, uint errorBitMask, string conversionFunctionName, string parameterChannelKey)

Parameters

Type	Name	Description
System.String	identifier	The identifier.
System.String	name	The name of the 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.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	conversionFunctionName	The conversion function.
System.String	parameterChannelKey	The parameter channel key.

Parameter(String, String, String, Double, Double, Double, Double, Double, UInt32, UInt32, String, UInt32)

Initialises a new instance of the Parameter class.

Declaration

public Parameter(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, uint dataBitMask, uint errorBitMask, string conversionFunctionName, uint channelId)

Parameters

Type	Name	Description
System.String	identifier	The identifier.
System.String	name	The name of the 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.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitMask	The error bit mask.
System.String	conversionFunctionName	The conversion function.
System.UInt32	channelId	The channel id.

Properties

ParameterType

Gets the ParameterType.

Declaration

public override ParameterType ParameterType { get; }

Property Value

Type	Description
ParameterType	The ParameterType.

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