Class Parameter

Holds the information related to the parameter like conversion, channels, group etc.

Inheritance

System.Object

Parameter

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: MAT.AtlasSessionApi

Assembly: MAT.AtlasSessionApi.dll

Syntax

public sealed class Parameter

Constructors

Parameter(String, String, String, String, IEnumerable<String>, ByteOrder, Range, Range, ParameterOperations, Conversion, IEnumerable<Channel>)

A new instance of the parameter.

Declaration

public Parameter(string group, string identifier, string name, string description, IEnumerable<string> subGroups, ByteOrder byteOrder, Range physicalRange, Range warningRange, ParameterOperations operations, Conversion conversion, IEnumerable<Channel> channels)

Parameters

Type	Name	Description
System.String	group	Group name.
System.String	identifier	Parameter identifier.
System.String	name	Parameter name.
System.String	description	Parameter description.
System.Collections.Generic.IEnumerable<System.String>	subGroups	List of sub groups.
ByteOrder	byteOrder	Byte order of the parameter.
Range	physicalRange	Upper and lower limit of the parameter.
Range	warningRange	Upper and lower warning limit of the parameter.
ParameterOperations	operations	Operation object such as mask, right shift and offset.
Conversion	conversion	Parameter conversion to convert raw value into physical value.
System.Collections.Generic.IEnumerable<Channel>	channels	Channel informations.

Exceptions

Type	Condition
System.ArgumentNullException	Exception for null input.
System.ArgumentException	Exception for empty input.

Properties

ByteOrder

Gets the byte order.

Declaration

public ByteOrder ByteOrder { get; }

Property Value

Type	Description
ByteOrder

Channels

Gets the collection of key/value pairs for the channels where key is defined as channel id.

Declaration

public IReadOnlyDictionary<uint, Channel> Channels { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyDictionary<System.UInt32, Channel>

Conversion

Gets the parameter conversion.

Declaration

public Conversion Conversion { get; }

Property Value

Type	Description
Conversion

Description

Gets the parameter description.

Declaration

public string Description { get; }

Property Value

Type	Description
System.String

Format

Gets the format of the parameter.

Declaration

public string Format { get; }

Property Value

Type	Description
System.String

Group

Gets the group of the parameter.

Declaration

public string Group { get; }

Property Value

Type	Description
System.String

Identifier

Gets the parameter identifier.

Declaration

public string Identifier { get; }

Property Value

Type	Description
System.String

Name

Gets the name of the parameter.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

Operations

Gets the operation information like data mask, error mask, right shift and offset to calculate the correct value of the parameter.

Declaration

public ParameterOperations Operations { get; }

Property Value

Type	Description
ParameterOperations

PhysicalRange

Gets the physical range.

Declaration

public Range PhysicalRange { get; }

Property Value

Type	Description
Range

PrimaryChannel

Gets the primary channel of the parameter.

Declaration

public Channel PrimaryChannel { get; }

Property Value

Type	Description
Channel

SubGroups

Gets the sub groups of the parameter.

Declaration

public IReadOnlyList<string> SubGroups { get; }

Property Value

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

Units

Gets the unit of the parameter.

Declaration

public string Units { get; }

Property Value

Type	Description
System.String

WarningRange

Gets the warning range.

Declaration

public Range WarningRange { get; }

Property Value

Type	Description
Range

Methods

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

Operators

Equality(Parameter, Parameter)

Are two parameters equal?

Declaration

public static bool operator ==(Parameter left, Parameter right)

Parameters

Type	Name	Description
Parameter	left	parameter object 1
Parameter	right	parameter object 2

Returns

Type	Description
System.Boolean

Inequality(Parameter, Parameter)

Are two parameters unequal?

Declaration

public static bool operator !=(Parameter left, Parameter right)

Parameters

Type	Name	Description
Parameter	left	parameter object 1
Parameter	right	parameter object 2

Returns

Type	Description
System.Boolean