Class ChannelBasedParameter

An abstract base class for parameters based on channels.

Inheritance
System.Object
ParameterBase
ChannelBasedParameter
FunctionParameter
Parameter
ScalarParameter
Implements
System.ComponentModel.INotifyPropertyChanged
Inherited Members
Namespace: MESL.SqlRace.Domain
Assembly: MESL.SqlRace.Domain.dll
Syntax
public abstract class ChannelBasedParameter : ParameterBase, IChannelBasedParameter, IParameter, INotifyPropertyChanged

Constructors

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

Initializes a new instance of the ChannelBasedParameter class.

Declaration
protected ChannelBasedParameter(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.

ChannelBasedParameter(String, String)

Initializes a new instance of the ChannelBasedParameter class.

Declaration
protected ChannelBasedParameter(string identifier, string name)
Parameters
Type Name Description
System.String identifier
System.String name

ChannelBasedParameter(String, String, String, Double, Double, Double, Double, Double, String, UInt32, UInt32, String, List<String>, IEnumerable<UInt32>)

Initializes a new instance of the ChannelBasedParameter class.

Declaration
protected ChannelBasedParameter(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, IEnumerable<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.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 application group name.
System.Collections.Generic.List<System.String> groupIdentifiers

The group identifiers.
System.Collections.Generic.IEnumerable<System.UInt32> channelIds

The channel IDs.

Properties

ChannelIds

Gets the channel IDs for this parameter.

Declaration
public IReadOnlyList<uint> ChannelIds { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyList<System.UInt32>

The channel IDs.

Channels

Gets the channels for this Parameter.

Declaration
public IReadOnlyList<IChannel> Channels { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyList<IChannel> System.Collections.Generic.List<>

InMemory

Is this an in memory parameter?

Declaration
public bool InMemory { get; }
Property Value
Type Description
System.Boolean

ParameterChannelKey

Gets the parameter channel key used for linking associated channels.

Declaration
protected string ParameterChannelKey { get; set; }
Property Value
Type Description
System.String

The parameter channel key.

Methods

AddChannel(IChannel)

Add an IChannel to this Parameter

Declaration
public void AddChannel(IChannel channel)
Parameters
Type Name Description
IChannel channel

The IChannel.
Remarks

Used by the DAL when rebuilding the parameter entity.

ApplyChannelOffset(UInt32)

Applies a channel offset to all Channels for this Parameter.

Declaration
public void ApplyChannelOffset(uint channelOffset)
Parameters
Type Name Description
System.UInt32 channelOffset

The channel offset.

MergeChannelIds(IReadOnlyCollection<UInt32>)

Merges the channel IDs.

Declaration
public void MergeChannelIds(IReadOnlyCollection<uint> channelIdsToMerge)
Parameters
Type Name Description
System.Collections.Generic.IReadOnlyCollection<System.UInt32> channelIdsToMerge

The channel IDs to merge.

MergeChannels(IReadOnlyCollection<IChannel>)

Merges the channels.

Declaration
public void MergeChannels(IReadOnlyCollection<IChannel> channelsToMerge)
Parameters
Type Name Description
System.Collections.Generic.IReadOnlyCollection<IChannel> channelsToMerge

The mergeable channels.

SetChannels(IReadOnlyCollection<IChannel>)

Sets the channels.

Declaration
public void SetChannels(IReadOnlyCollection<IChannel> newChannels)
Parameters
Type Name Description
System.Collections.Generic.IReadOnlyCollection<IChannel> newChannels

The new channels.
Remarks

Used by the DAL when rebuilding the parameter entity.

Implements

System.ComponentModel.INotifyPropertyChanged