Show / Hide Table of Contents

Class ParameterBuilder<B>

Build the rational or text conversion parameters.

Inheritance
System.Object
ParameterBuilder<B>
RationalParameterBuilder
TextParameterBuilder
Implements
IChannelBuilder
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 abstract class ParameterBuilder<B> : IChannelBuilder where B : ParameterBuilder<B>
Type Parameters
Name Description
B

Constructors

ParameterBuilder(ISessionBuilder, String, String)

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

Fields

byteOrder

Declaration
protected ByteOrder byteOrder
Field Value
Type Description
ByteOrder

description

Declaration
protected string description
Field Value
Type Description
System.String

format

Declaration
protected string format
Field Value
Type Description
System.String

group

Declaration
protected readonly string group
Field Value
Type Description
System.String

identifier

Declaration
protected string identifier
Field Value
Type Description
System.String

name

Declaration
protected readonly string name
Field Value
Type Description
System.String

operations

Declaration
protected ParameterOperations operations
Field Value
Type Description
ParameterOperations

physicalRange

Declaration
protected Range physicalRange
Field Value
Type Description
Range

sessionBuilder

Declaration
protected readonly ISessionBuilder sessionBuilder
Field Value
Type Description
ISessionBuilder

subGroups

Declaration
protected List<string> subGroups
Field Value
Type Description
System.Collections.Generic.List<System.String>

units

Declaration
protected string units
Field Value
Type Description
System.String

warningRange

Declaration
protected Range warningRange
Field Value
Type Description
Range

Methods

BuildParameter(ICollection<Channel>)

Declaration
protected abstract Parameter BuildParameter(ICollection<Channel> collection)
Parameters
Type Name Description
System.Collections.Generic.ICollection<Channel> collection
Returns
Type Description
Parameter

ByteOrder(ByteOrder)

Declaration
public virtual B ByteOrder(ByteOrder byteOrder)
Parameters
Type Name Description
ByteOrder byteOrder
Returns
Type Description
B

Description(String)

Declaration
public virtual B Description(string description)
Parameters
Type Name Description
System.String description
Returns
Type Description
B

Format(String)

Declaration
public virtual B Format(string format)
Parameters
Type Name Description
System.String format
Returns
Type Description
B

GetFormat()

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

GetIdentifier()

Declaration
protected virtual string GetIdentifier()
Returns
Type Description
System.String

GetPhysicalRange()

Declaration
protected abstract Range GetPhysicalRange()
Returns
Type Description
Range

GetWarningRange()

Declaration
protected virtual Range GetWarningRange()
Returns
Type Description
Range

Identifier(String)

Declaration
public virtual B Identifier(string identifier)
Parameters
Type Name Description
System.String identifier
Returns
Type Description
B

OnChannel(Channel)

Declaration
public IBuiltParameter OnChannel(Channel channel)
Parameters
Type Name Description
Channel channel
Returns
Type Description
IBuiltParameter

OnPeriodicChannel(Frequency, DataType)

Declaration
public IBuiltParameter OnPeriodicChannel(Frequency frequency, DataType dataType = DataType.FloatingPoint32Bit)
Parameters
Type Name Description
Frequency frequency
DataType dataType
Returns
Type Description
IBuiltParameter

Operations(ParameterOperations)

Declaration
public virtual B Operations(ParameterOperations operations)
Parameters
Type Name Description
ParameterOperations operations
Returns
Type Description
B

PhysicalRange(Range)

Declaration
public virtual B PhysicalRange(Range range)
Parameters
Type Name Description
Range range
Returns
Type Description
B

PhysicalRange(Double, Double)

Declaration
public virtual B PhysicalRange(double lower, double upper)
Parameters
Type Name Description
System.Double lower
System.Double upper
Returns
Type Description
B

SubGroups(List<String>)

Declaration
public virtual B SubGroups(List<string> subGroups)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> subGroups
Returns
Type Description
B

Units(String)

Declaration
public virtual B Units(string units)
Parameters
Type Name Description
System.String units
Returns
Type Description
B

WarningRange(Range)

Declaration
public virtual B WarningRange(Range range)
Parameters
Type Name Description
Range range
Returns
Type Description
B

WarningRange(Double, Double)

Declaration
public virtual B WarningRange(double lower, double upper)
Parameters
Type Name Description
System.Double lower
System.Double upper
Returns
Type Description
B

Implements

IChannelBuilder
In This Article
Back to top Generated by DocFX