Class TextParameterBuilder

Build the parameter which uses text conversion.

Inheritance
System.Object
ParameterBuilder<TextParameterBuilder>
TextParameterBuilder
Implements
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: MAT.AtlasSessionApi
Assembly: MAT.AtlasSessionApi.dll
Syntax
public sealed class TextParameterBuilder : ParameterBuilder<TextParameterBuilder>, IChannelBuilder

Constructors

TextParameterBuilder(ISessionBuilder, String, String)

Update the text parameter builder object.

Declaration
public TextParameterBuilder(ISessionBuilder sessionBuilder, string group, string name)
Parameters
Type Name Description
ISessionBuilder sessionBuilder
System.String group
System.String name

Methods

AddLookup(Double, String)

Add lookup table for text conversion.

Declaration
public TextParameterBuilder AddLookup(double input, string value)
Parameters
Type Name Description
System.Double input
System.String value
Returns
Type Description
TextParameterBuilder
Exceptions
Type Condition
System.ArgumentNullException
System.ArgumentException

BuildParameter(ICollection<Channel>)

Declaration
protected override Parameter BuildParameter(ICollection<Channel> channels)
Parameters
Type Name Description
System.Collections.Generic.ICollection<Channel> channels
Returns
Type Description
Parameter
Overrides
MAT.AtlasSessionApi.ParameterBuilder<MAT.AtlasSessionApi.TextParameterBuilder>.BuildParameter(System.Collections.Generic.ICollection<MAT.AtlasSessionApi.Channel>)

DefaultValue(String)

Update the default value.

Declaration
public TextParameterBuilder DefaultValue(string defaultVal)
Parameters
Type Name Description
System.String defaultVal

default value in lookup table.
Returns
Type Description
TextParameterBuilder

text parameter builder object.
Exceptions
Type Condition
System.ArgumentNullException

throw exception if default value is null.

GetFormat()

Gets the format of the conversion.

Declaration
protected override string GetFormat()
Returns
Type Description
System.String

Get the format of text conversion.
Overrides
MAT.AtlasSessionApi.ParameterBuilder<MAT.AtlasSessionApi.TextParameterBuilder>.GetFormat()

GetPhysicalRange()

Gets the minimum and maximum value of the lookup table.

Declaration
protected override Range GetPhysicalRange()
Returns
Type Description
Range
Overrides
MAT.AtlasSessionApi.ParameterBuilder<MAT.AtlasSessionApi.TextParameterBuilder>.GetPhysicalRange()

LookupTable(IDictionary<Double, String>)

Prepare the lookup table for text conversion.

Declaration
public TextParameterBuilder LookupTable(IDictionary<double, string> lookupTable)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.Double, System.String> lookupTable
Returns
Type Description
TextParameterBuilder
Exceptions
Type Condition
System.ArgumentNullException

Implements