Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Parameter<T>

Parameter represents a KeyName, KeyTag, array of values and units applicable to values. Parameter sits as payload for sending commands and events between components.

Type parameters

Hierarchy

  • Parameter

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Parameter<T>(keyName: string, keyTag: KTag<T>, values: KType<T>[], units: Units): Parameter<T>
  • tparam

    T the type of items this parameter holds

    Type parameters

    Parameters

    • keyName: string

      the name of the key

    • keyTag: KTag<T>

      reference to an object of type KeyType[S]

    • values: KType<T>[]

      an Array of values of type S

    • units: Units

      applicable units

    Returns Parameter<T>

Properties

Readonly keyName

keyName: string

Readonly keyTag

keyTag: KTag<T>

Readonly units

units: Units

Readonly values

values: KType<T>[]

Methods

toJSON

  • toJSON(): {}

Generated using TypeDoc