Class cValueRecord

Represents a value record of process history data, containing a time stamp, a value and status information.

Hierarchy (View Summary)

cValueStatus
- cValueRecord

Implements

IValueStatus

Constructors

constructor

new cValueRecord(
    rawtimestamp: string,
    rawvalue: unknown,
    statushexstr: string,
    valuestr?: string,
    statusstr?: string,
    readonly?: boolean,
    rawprevioustime?: string,
): cValueRecord
Create a new value record.
Parameters
- rawtimestamp: string
  The time stamp as numeric string (UTC, 100 nanoseconds since January 1st 1970).
- rawvalue: unknown
  The raw value.
- statushexstr: string
  The status bits as hexadecimal numeric string.
- Optionalvaluestr: string = null
  The server formatted string representation of the value.
- Optionalstatusstr: string
  The server formatted string reprepsentation of the status.
- Optionalreadonly: boolean
  The value status cannot be changed.
- Optionalrawprevioustime: string
  The time stamp of the previous value time as numeric string (UTC, 100 nanoseconds since January 1st 1970).
Returns cValueRecord
Overrides cValueStatus.constructor
- Defined in mia/ts/client/data/valuerecord.ts:38

Accessors

AccessDenied

get AccessDenied(): boolean
Returns boolean
Implementation of IValueStatus.AccessDenied
Inherited from cValueStatus.AccessDenied
- Defined in mia/ts/client/data/valuestatus.ts:140

AlarmLevel

get AlarmLevel(): number
Returns number
Implementation of IValueStatus.AlarmLevel
Inherited from cValueStatus.AlarmLevel
- Defined in mia/ts/client/data/valuestatus.ts:141

Bad

get Bad(): boolean
Returns boolean
Implementation of IValueStatus.Bad
Inherited from cValueStatus.Bad
- Defined in mia/ts/client/data/valuestatus.ts:159
set Bad(value: boolean): void
Parameters
- value: boolean
Returns void
Implementation of IValueStatus.Bad
Inherited from cValueStatus.Bad
- Defined in mia/ts/client/data/valuestatus.ts:174

Decreasing

get Decreasing(): boolean
Returns boolean
Implementation of IValueStatus.Decreasing
Inherited from cValueStatus.Decreasing
- Defined in mia/ts/client/data/valuestatus.ts:142

Disabled

get Disabled(): boolean
Returns boolean
Implementation of IValueStatus.Disabled
Inherited from cValueStatus.Disabled
- Defined in mia/ts/client/data/valuestatus.ts:160
set Disabled(value: boolean): void
Parameters
- value: boolean
Returns void
Implementation of IValueStatus.Disabled
Inherited from cValueStatus.Disabled
- Defined in mia/ts/client/data/valuestatus.ts:175

EndOfSlice

get EndOfSlice(): boolean
Returns boolean
Implementation of IValueStatus.EndOfSlice
Inherited from cValueStatus.EndOfSlice
- Defined in mia/ts/client/data/valuestatus.ts:143

Extrapolated

get Extrapolated(): boolean
Returns boolean
Implementation of IValueStatus.Extrapolated
Inherited from cValueStatus.Extrapolated
- Defined in mia/ts/client/data/valuestatus.ts:144

Fake

get Fake(): boolean
Returns boolean
Implementation of IValueStatus.Fake
Inherited from cValueStatus.Fake
- Defined in mia/ts/client/data/valuestatus.ts:145

Frozen

get Frozen(): boolean
Returns boolean
Implementation of IValueStatus.Frozen
Inherited from cValueStatus.Frozen
- Defined in mia/ts/client/data/valuestatus.ts:146

HistorySubstituted

get HistorySubstituted(): boolean
Returns boolean
Implementation of IValueStatus.HistorySubstituted
Inherited from cValueStatus.HistorySubstituted
- Defined in mia/ts/client/data/valuestatus.ts:161
set HistorySubstituted(value: boolean): void
Parameters
- value: boolean
Returns void
Implementation of IValueStatus.HistorySubstituted
Inherited from cValueStatus.HistorySubstituted
- Defined in mia/ts/client/data/valuestatus.ts:176

Incomplete

get Incomplete(): boolean
Returns boolean
Implementation of IValueStatus.Incomplete
Inherited from cValueStatus.Incomplete
- Defined in mia/ts/client/data/valuestatus.ts:147

Increasing

get Increasing(): boolean
Returns boolean
Implementation of IValueStatus.Increasing
Inherited from cValueStatus.Increasing
- Defined in mia/ts/client/data/valuestatus.ts:148

Interpolated

get Interpolated(): boolean
Returns boolean
Implementation of IValueStatus.Interpolated
Inherited from cValueStatus.Interpolated
- Defined in mia/ts/client/data/valuestatus.ts:149

Invalid

get Invalid(): boolean
Returns boolean
Implementation of IValueStatus.Invalid
Inherited from cValueStatus.Invalid
- Defined in mia/ts/client/data/valuestatus.ts:162
set Invalid(value: boolean): void
Parameters
- value: boolean
Returns void
Implementation of IValueStatus.Invalid
Inherited from cValueStatus.Invalid
- Defined in mia/ts/client/data/valuestatus.ts:177

LastInSequence

get LastInSequence(): boolean
Returns boolean
Implementation of IValueStatus.LastInSequence
Inherited from cValueStatus.LastInSequence
- Defined in mia/ts/client/data/valuestatus.ts:163
set LastInSequence(value: boolean): void
Parameters
- value: boolean
Returns void
Implementation of IValueStatus.LastInSequence
Inherited from cValueStatus.LastInSequence
- Defined in mia/ts/client/data/valuestatus.ts:178

ManuallySet

get ManuallySet(): boolean
Returns boolean
Implementation of IValueStatus.ManuallySet
Inherited from cValueStatus.ManuallySet
- Defined in mia/ts/client/data/valuestatus.ts:164
set ManuallySet(value: boolean): void
Parameters
- value: boolean
Returns void
Implementation of IValueStatus.ManuallySet
Inherited from cValueStatus.ManuallySet
- Defined in mia/ts/client/data/valuestatus.ts:179

NonAckAlarm

get NonAckAlarm(): boolean
Returns boolean
Implementation of IValueStatus.NonAckAlarm
Inherited from cValueStatus.NonAckAlarm
- Defined in mia/ts/client/data/valuestatus.ts:151

NoStatus

get NoStatus(): boolean
Returns boolean
Implementation of IValueStatus.NoStatus
Inherited from cValueStatus.NoStatus
- Defined in mia/ts/client/data/valuestatus.ts:152

OK

get OK(): boolean
Returns boolean
Implementation of IValueStatus.OK
Inherited from cValueStatus.OK
- Defined in mia/ts/client/data/valuestatus.ts:150

Producer

get Producer(): number
Returns number
Implementation of IValueStatus.Producer
Inherited from cValueStatus.Producer
- Defined in mia/ts/client/data/valuestatus.ts:165
set Producer(value: number): void
Parameters
- value: number
Returns void
Implementation of IValueStatus.Producer
Inherited from cValueStatus.Producer
- Defined in mia/ts/client/data/valuestatus.ts:180

Questionable

get Questionable(): boolean
Returns boolean
Implementation of IValueStatus.Questionable
Inherited from cValueStatus.Questionable
- Defined in mia/ts/client/data/valuestatus.ts:166
set Questionable(value: boolean): void
Parameters
- value: boolean
Returns void
Implementation of IValueStatus.Questionable
Inherited from cValueStatus.Questionable
- Defined in mia/ts/client/data/valuestatus.ts:181

Reason

get Reason(): cValueStatusReason
Returns cValueStatusReason
Implementation of IValueStatus.Reason
Inherited from cValueStatus.Reason
- Defined in mia/ts/client/data/valuestatus.ts:153

Representativeness

get Representativeness(): number
Returns number
Implementation of IValueStatus.Representativeness
Inherited from cValueStatus.Representativeness
- Defined in mia/ts/client/data/valuestatus.ts:167
set Representativeness(value: number): void
Parameters
- value: number
Returns void
Implementation of IValueStatus.Representativeness
Inherited from cValueStatus.Representativeness
- Defined in mia/ts/client/data/valuestatus.ts:182

RepresentativenessCV

get RepresentativenessCV(): number
Returns number
Implementation of IValueStatus.RepresentativenessCV
Inherited from cValueStatus.RepresentativenessCV
- Defined in mia/ts/client/data/valuestatus.ts:168
set RepresentativenessCV(value: number): void
Parameters
- value: number
Returns void
Implementation of IValueStatus.RepresentativenessCV
Inherited from cValueStatus.RepresentativenessCV
- Defined in mia/ts/client/data/valuestatus.ts:183

StartOfSlice

get StartOfSlice(): boolean
Returns boolean
Implementation of IValueStatus.StartOfSlice
Inherited from cValueStatus.StartOfSlice
- Defined in mia/ts/client/data/valuestatus.ts:154

Substituted

get Substituted(): boolean
Returns boolean
Implementation of IValueStatus.Substituted
Inherited from cValueStatus.Substituted
- Defined in mia/ts/client/data/valuestatus.ts:169
set Substituted(value: boolean): void
Parameters
- value: boolean
Returns void
Implementation of IValueStatus.Substituted
Inherited from cValueStatus.Substituted
- Defined in mia/ts/client/data/valuestatus.ts:184

SuppressedAlarm

get SuppressedAlarm(): boolean
Returns boolean
Implementation of IValueStatus.SuppressedAlarm
Inherited from cValueStatus.SuppressedAlarm
- Defined in mia/ts/client/data/valuestatus.ts:155

Uninitialized

get Uninitialized(): boolean
Returns boolean
Implementation of IValueStatus.Uninitialized
Inherited from cValueStatus.Uninitialized
- Defined in mia/ts/client/data/valuestatus.ts:156

UserStatus

get UserStatus(): number
Returns number
Implementation of IValueStatus.UserStatus
Inherited from cValueStatus.UserStatus
- Defined in mia/ts/client/data/valuestatus.ts:170
set UserStatus(value: number): void
Parameters
- value: number
Returns void
Implementation of IValueStatus.UserStatus
Inherited from cValueStatus.UserStatus
- Defined in mia/ts/client/data/valuestatus.ts:185

UserStatusExtended

get UserStatusExtended(): number
Returns number
Implementation of IValueStatus.UserStatusExtended
Inherited from cValueStatus.UserStatusExtended
- Defined in mia/ts/client/data/valuestatus.ts:171
set UserStatusExtended(value: number): void
Parameters
- value: number
Returns void
Implementation of IValueStatus.UserStatusExtended
Inherited from cValueStatus.UserStatusExtended
- Defined in mia/ts/client/data/valuestatus.ts:186

Methods

GetPreviousTime

GetPreviousTime(connection?: IMiaClient): cDateTime
Gets the previous value UTC time stamp.
Parameters
- Optionalconnection: IMiaClient
  A connection for the returned cDateTime. (Defaults to the default connection.)
Returns cDateTime
- Defined in mia/ts/client/data/valuerecord.ts:126

GetRawPreviousTime

GetRawPreviousTime(): string
Gets the time stamp of the previous value time as numeric string (UTC, 100 nanoseconds since January 1st 1970).

Returns string
- Defined in mia/ts/client/data/valuerecord.ts:116

GetRawStatus

GetRawStatus(): string
Returns string
Inherited from cValueStatus.GetRawStatus
- Defined in mia/ts/client/data/valuestatus.ts:120

GetRawTime

GetRawTime(): string
Gets the time stamp as a numeric string (UTC, 100 nanoseconds since January 1st 1970).

Returns string
- Defined in mia/ts/client/data/valuerecord.ts:112

GetRawValue

GetRawValue(): unknown
Gets the value in raw format.

Returns unknown
- Defined in mia/ts/client/data/valuerecord.ts:108

GetResolvedStatusForTooltip

GetResolvedStatusForTooltip(
    connection: IMiaClient,
    userstatusid?: number,
    omitshortstatus?: boolean,
): string
Parameters
- connection: IMiaClient
- userstatusid: number = 0
- omitshortstatus: boolean = false
Returns string
- Defined in mia/ts/client/data/valuerecord.ts:149

GetStatusString

GetStatusString(connection: IMiaClient): string
Parameters
- connection: IMiaClient
Returns string
Inherited from cValueStatus.GetStatusString
- Defined in mia/ts/client/data/valuestatus.ts:130

GetTime

GetTime(connection?: IMiaClient): cDateTime
Gets the UTC time stamp.
Parameters
- Optionalconnection: IMiaClient
  A connection for the returned cDateTime. (Defaults to the default connection.)
Returns cDateTime
- Defined in mia/ts/client/data/valuerecord.ts:121

GetTooltip

GetTooltip(
    connection: IMiaClient,
    unit?: string,
    decimals?: number,
    istable?: boolean,
    showstatustext?: boolean,
    showseparateicon?: boolean,
    userstatusid?: number,
): string
Parameters
- connection: IMiaClient
- unit: string = null
- decimals: number = undefined
- istable: boolean = false
- showstatustext: boolean = true
- showseparateicon: boolean = false
- userstatusid: number = 0
Returns string
- Defined in mia/ts/client/data/valuerecord.ts:128

GetValueString

GetValueString(
    decimals?: number,
    alwaysshowsign?: boolean,
    numberformat?: INumberFormatOptions,
    usefixeddecimals?: boolean,
): string
Gets a string representation of the value.
Parameters
- Optionaldecimals: number
  The max number of decimals in the returned string value.
- Optionalalwaysshowsign: boolean = false
  Show positive number sign.
- Optionalnumberformat: INumberFormatOptions
  Number formatting options.
- Optionalusefixeddecimals: boolean = false
  Use fixed number of decimals as specified in the decimals parameter, instead of variable decimals up to the specified number.
Returns string
- Defined in mia/ts/client/data/valuerecord.ts:60

toJSON

toJSON(): unknown[]
Returns unknown[]
Overrides cValueStatus.toJSON
- Defined in mia/ts/client/data/valuerecord.ts:147

`Static`IsReadOnly

IsReadOnly(statusname: keyof IValueStatus): boolean
Parameters
- statusname: keyof IValueStatus
Returns boolean
Inherited from cValueStatus.IsReadOnly
- Defined in mia/ts/client/data/valuestatus.ts:138

Class cValueRecord

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns cValueRecord

Accessors

AccessDenied

Returns boolean

AlarmLevel

Returns number

Bad

Returns boolean

Parameters

Returns void

Decreasing

Returns boolean

Disabled

Returns boolean

Parameters

Returns void

EndOfSlice

Returns boolean

Extrapolated

Returns boolean

Fake

Returns boolean

Frozen

Returns boolean

HistorySubstituted

Returns boolean

Parameters

Returns void

Incomplete

Returns boolean

Increasing

Returns boolean

Interpolated

Returns boolean

Invalid

Returns boolean

Parameters

Returns void

LastInSequence

Returns boolean

Parameters

Returns void

ManuallySet

Returns boolean

Parameters

Returns void

NonAckAlarm

Returns boolean

NoStatus

Returns boolean

OK

Returns boolean

Producer

Returns number

Parameters

Returns void

Questionable

Returns boolean

Parameters

Returns void

Reason

Returns cValueStatusReason

Representativeness

Returns number

Parameters

Returns void

RepresentativenessCV

Returns number

Parameters

Returns void

`Static`IsReadOnly