Class ParameterBase

An abstract base class for Parameters.

Inheritance

System.Object

ParameterBase

ChannelBasedParameter

VirtualParameter

Implements

IParameter

System.ComponentModel.INotifyPropertyChanged

Namespace: MESL.SqlRace.Domain

Assembly: MESL.SqlRace.Domain.dll

Syntax

public abstract class ParameterBase : Object, IParameter, INotifyPropertyChanged

Constructors

ParameterBase(Func<String, String>, String, String, String, Double, Double, Double, Double, Double, String, UInt32, UInt32, String, List<String>)

Initializes a new instance of the ParameterBase class.

Declaration

protected ParameterBase(Func<string, string> decryptionFunc, string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, string conversionFunctionName, uint dataBitMask, uint errorBitmask, string applicationName, List<string> groupIdentifiers)

Parameters

Type	Name	Description
System.Func<System.String, System.String>	decryptionFunc	The decryption function.
System.String	identifier	The identifier.
System.String	name	The 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.String	conversionFunctionName	Name of the conversion function.
System.UInt32	dataBitMask	The data bit mask.
System.UInt32	errorBitmask	The error bit mask.
System.String	applicationName	Name of the application.
System.Collections.Generic.List<System.String>	groupIdentifiers	The group identifiers.

Exceptions

Type	Condition
System.ArgumentNullException	conversionFunctionName

ParameterBase(String, String)

Initialises a new instance of the ParameterBase class.

Declaration

protected ParameterBase(string identifier, string name)

Parameters

Type	Name	Description
System.String	identifier
System.String	name

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

Initialises a new instance of the ParameterBase class.

Declaration

protected ParameterBase(string identifier, string name, string description, double maximumValue, double minimumValue, double warningMaximumValue, double warningMinimumValue, double offsetValue, string conversionFunctionName, uint dataBitMask, uint errorBitmask, string applicationName, List<string> groupIdentifiers)

Parameters

Type	Name	Description
System.String	identifier	The parameter identifier (i.e vCar:Chassis).
System.String	name	The parameter name (i.e vCar).
System.String	description	The parameter 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 parameter 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	applicationName	The ApplicationGroup name.
System.Collections.Generic.List<System.String>	groupIdentifiers	The ParameterGroup Identifiers.

Properties

ApplicationName

Gets or sets the ApplicationGroup name for this parameter.

Declaration

public string ApplicationName { get; set; }

Property Value

Type	Description
System.String

Available

Gets a value indicating whether this ParameterBase is available.

Declaration

public bool Available { get; }

Property Value

Type	Description
System.Boolean	`true` if available; otherwise, `false`.

BitShift

Gets or sets the bit shift for the parameter.

Declaration

public short BitShift { get; set; }

Property Value

Type	Description
System.Int16

Remarks

The default value is 0.

ByteOrder

Gets or sets the ByteOrderType for the parameter.

Declaration

public ByteOrderType ByteOrder { get; set; }

Property Value

Type	Description
ByteOrderType

Remarks

The default value is ByteOrderType.LittleEndian.

CanRecalculate

Gets a value indicating whether this instance can be recalculated.

Declaration

public virtual bool CanRecalculate { get; }

Property Value

Type	Description
System.Boolean	`true` if this instance can be recalculated; otherwise, `false`.

ConversionFunctionName

Gets or sets the name of the conversion function that is applied to data values for this parameter.

Declaration

public string ConversionFunctionName { get; set; }

Property Value

Type	Description
System.String

DataBitMask

Gets or sets the bit mask used to provide a value to the parameter.

Declaration

public uint DataBitMask { get; set; }

Property Value

Type	Description
System.UInt32

Description

Gets or sets the description of the parameter.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

ErrorBitmask

Gets or sets the bit mask used to provide an error value to the parameter.

Declaration

public uint ErrorBitmask { get; set; }

Property Value

Type	Description
System.UInt32

FormatOverride

Gets or sets the format override for the parameter. This can be used to override the format specified in the conversion function.

Declaration

public string FormatOverride { get; set; }

Property Value

Type	Description
System.String

GroupIdentifiers

Gets or sets the list of parameter group identifiers this parameter belongs to.

Declaration

public List<string> GroupIdentifiers { get; set; }

Property Value

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

Identifier

Gets or sets the Parameter Identifier.

Declaration

public string Identifier { get; }

Property Value

Type	Description
System.String

Remarks

*** IMPORTANT *** This property must not be changed once set. It's underlying member variable should be readonly, but it can be decrypted shortly after creation, so unfortunately, it must remain mutable.

MaximumValue

Gets or sets the maximum expected value for the parameter.

Declaration

public double MaximumValue { get; set; }

Property Value

Type	Description
System.Double

MinimumValue

Gets or sets the minimum expected value for the parameter.

Declaration

public double MinimumValue { get; set; }

Property Value

Type	Description
System.Double

Name

Gets or sets the name of the parameter.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

Remarks

OffsetValue

Gets or sets the offset value.

Declaration

public double OffsetValue { get; set; }

Property Value

Type	Description
System.Double

ParameterType

Gets the type of the parameter.

Declaration

public abstract ParameterType ParameterType { get; }

Property Value

Type	Description
ParameterType	The type of the parameter.

ShowInBrowser

Gets a value indicating whether this instance is available to browsers.

Declaration

public virtual bool ShowInBrowser { get; }

Property Value

Type	Description
System.Boolean	`true` if this instance is available to browsers; otherwise, `false`.

Unit

Gets or sets unit for this parameter.

Declaration

public string Unit { get; set; }

Property Value

Type	Description
System.String

UserType

Gets or sets the usage type of this parameter.

Declaration

public ParameterUsageType UserType { get; set; }

Property Value

Type	Description
ParameterUsageType	Usage Type.

WarningMaximumValue

Gets or sets the highest value that should trigger a warning in the display.

Declaration

public double WarningMaximumValue { get; set; }

Property Value

Type	Description
System.Double

WarningMinimumValue

Gets or sets the lowest value that should trigger a warning in the display.

Declaration

public double WarningMinimumValue { get; set; }

Property Value

Type	Description
System.Double

Methods

NotifyPropertyChanged(String)

Notifies of a property changed event by raising the event.

Declaration

protected virtual void NotifyPropertyChanged(string propertyName = null)

Parameters

Type	Name	Description
System.String	propertyName	Name of the property.

Recalculate()

Recalculates this instance.

Declaration

public virtual void Recalculate()

Exceptions

Type	Condition
System.NotSupportedException

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.

Events

AvailabilityChanged

Occurs when the availability of this Parameter has changed.

Declaration

public event EventHandler<AvailabilityChangedEventArgs> AvailabilityChanged

Event Type

Type	Description
System.EventHandler<AvailabilityChangedEventArgs>

PropertyChanged

Occurs when a property value changes.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
System.ComponentModel.PropertyChangedEventHandler

UnderlyingDataSourceChanged

Occurs when [underlying data source changed].

Declaration

public abstract event EventHandler UnderlyingDataSourceChanged

Event Type

Type	Description
System.EventHandler

Implements

IParameter

System.ComponentModel.INotifyPropertyChanged