Class cCurrentValueAccessor

cCurrentValueAccessor - Access current values in server data source

import { IConnection } from "client/connection";
import { cValueRecord } from "client/data";
import { IDbClassInstance } from "db/cache";
import { cCurrentValueAccessor } from "valueaccessors/currentvalueaccessor";
function example(conn:IConnection, path:IDbClassInstance)
{
   const cva:cCurrentValueAccessor = new cCurrentValueAccessor({
      Source:   path.Class.Id,
      Instance: path.Get("Id"),
      Property: "CurrentPower"
   });
   cva.Changed.AddListener(()=>{
      const vr:cValueRecord=cva.ValueRecord.Get();
      console.log(
         "time:",     vr.GetTime().ToString("G"),
         "value:",    vr.GetValueString(),
         "rawvalue:", vr.GetRawValue(),
         "invalid:",  vr.Invalid
      );
   });
}

Hierarchy (View Summary)

cSingleValueAccessorBase
- cCurrentValueAccessor

Constructors

constructor

new cCurrentValueAccessor(
config?: ICurrentValueAccessorConfig,
): cCurrentValueAccessor
Parameters
- Optionalconfig: ICurrentValueAccessorConfig
Returns cCurrentValueAccessor
Overrides cSingleValueAccessorBase.constructor
- Defined in mia/ts/valueaccessors/currentvalueaccessor.ts:57

Properties

`Readonly`AutoScaling

AutoScaling: IProperty<boolean> = ...

Have the widget to set the scale automatically according the incoming values. (Only supported by certain accessors.)

`Readonly`AutoScalingMode

AutoScalingMode: IProperty<AutoScaleMode> = ...

The type of auto scaling used.

`Readonly`Changed

Changed: IEvent<void> = ...

Fired when the data of the value accessor has changed.

`Readonly`Connection

Connection: IConnectionAPI

The connection API for the value accessor

`Readonly`Context

Context: IContextAPI = ...

The context handling API for the value accessor

`Readonly`ConvertTimeSpan

ConvertTimeSpan: IProperty<boolean> = ...

Convert time span values to numeric values (as approx. ticks).

`Readonly`CustomDescription

CustomDescription: IProperty<string> = ...

The user-definable description that overrides any defaults.

`Readonly`CustomMaximumValue

CustomMaximumValue: IProperty<number> = ...

The user-definable minimum value that overrides any defaults.

`Readonly`CustomMinimumValue

CustomMinimumValue: IProperty<number> = ...

The user-definable minimum value that overrides any defaults.

`Readonly`CustomName

CustomName: IProperty<string> = ...

The user-definable name that overrides any defaults.

`Readonly`CustomUnit

CustomUnit: IProperty<string> = ...

The user-definable unit that overrides any defaults.

`Readonly`DefaultStorage

DefaultStorage: IDefaultStorage = ...

Default property value storage - used by the default property getters and setters.

`Readonly`Description

Description: IProperty<string> = ...

The description shown to user. (Automatically fetched)

`Readonly`DisplayName

DisplayName: IProperty<string> = ...

The display name shown to user.

`Readonly`DisposeEvent

DisposeEvent: IManualEvent<void>

Dispose Event signaled when the object is being disposed. NOTE: Inheriting classes should use AddDisposeHandler instead.

`Readonly`Events

Events: IEvents

cClassBase event API

`Readonly`Initialized

Initialized: IManualEvent<void> = ...

Fired when the value accessor has been initialized.

`Readonly`InitializeFailed

InitializeFailed: IManualEvent<void> = ...

Fired when the value accessor initialization has failed.

`Readonly`Instance

Instance: IProperty<unknown> = ...

The source instance of the data

`Readonly`MaximumValue

MaximumValue: IProperty<unknown> = ...

The default maximum value. (Automatically fetched)

`Readonly`MinimumValue

MinimumValue: IProperty<unknown> = ...

The default minimum value. (Automatically fetched)

`Readonly`OwnerWidget

OwnerWidget: IProperty<cWidgetBase> = ...

The owner widget of the single value accessor

`Readonly`PathName

PathName: IProperty<string> = ...

Process path that may be shown in the tooltip

`Readonly`Property

Property: IProperty<string> = ...

The source property of the data (If null when Source is "Variable" CurrentValue is automatically shown.)

`Readonly`ShowDescription

ShowDescription: IProperty<boolean> = ...

Show the description in the item tooltip.

`Readonly`ShowOwner

ShowOwner: IProperty<boolean> = ...

Show the name of the owner instance in the item name.

`Readonly`Source

Source: IProperty<string> = ...

The source class of the data

`Readonly`TooltipDecimals

TooltipDecimals: IProperty<number> = ...

Max. Number of decimals shown in the tooltip

`Readonly`UId

UId: IProperty<string>

`Readonly`Unit

Unit: IProperty<string> = ...

The default unit. (Automatically fetched)

`Readonly`Value

Value: IProperty<unknown> = ...

The latest value received by the accessor.

`Readonly`ValueRecord

ValueRecord: IProperty<cValueRecord> = ...

The value record containing the time stamp, the value and the status information.

Accessors

CanDispose

get CanDispose(): boolean
The object can be disposed

Returns boolean
Inherited from cSingleValueAccessorBase.CanDispose
- Defined in mia/ts/client/classbase.ts:39
set CanDispose(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from cSingleValueAccessorBase.CanDispose
- Defined in mia/ts/client/classbase.ts:40

NLS

get NLS(): IComponentNLSRequest
The component class specific NLS request

Returns IComponentNLSRequest
Inherited from cSingleValueAccessorBase.NLS
- Defined in mia/ts/componentbase/componentbase.ts:39

Properties

get Properties(): IPropertyAPI
The component property API

Returns IPropertyAPI
Inherited from cSingleValueAccessorBase.Properties
- Defined in mia/ts/componentbase/componentbase.ts:41

Methods

`Protected`__initLegacyBase

__initLegacyBase(): ILegacyBase
Returns ILegacyBase
Inherited from cSingleValueAccessorBase.__initLegacyBase
- Defined in mia/ts/valueaccessors/valueaccessorbase.ts:299

Abortable

Abortable<TArgs extends unknown[] = []>(
func: TAsyncAbortable<TArgs>,
disposeonly?: boolean,
): TAsyncAbortableReturn<TArgs>
Create function that can abort asynchronous code in case the function is called again or the owner instance have been disposed. This is useful with problematic cases where for example server request is sent and the return is handled asynchronously (with a callback). Meanwhile the configuration may have changed making the code in the callback unnecessary or even harmful. *
Type Parameters
- TArgs extends unknown[] = []
Parameters
- func: TAsyncAbortable<TArgs>
  A function with first parameter as function to check the abort state: Can be used in the function: if(abort()) return; //abort
- disposeonly: boolean = false
  Check only the dispose state - don't check subsequent calls to the function.
Returns TAsyncAbortableReturn<TArgs>
Inherited from cSingleValueAccessorBase.Abortable
- Defined in mia/ts/client/classbase.ts:105

`Protected`AddDisposeHandler

AddDisposeHandler(disposer: () => void): void
Add a dispose handler called when this object is being disposed. The dispose handlers are called in reverse order (the latest first).
Parameters
- disposer: () => void
  The dispose handler - should make any manual clean up necessary when the object is being disposed.
Returns void
Inherited from cSingleValueAccessorBase.AddDisposeHandler
- Defined in mia/ts/client/classbase.ts:147

AutoDispose

AutoDispose(disposables: IDisposable | IDisposable[]): void
Automatically dispose the given objects when this object is disposed.
Parameters
- disposables: IDisposable | IDisposable[]
  The objects to dispose along with this object.
Returns void
Inherited from cSingleValueAccessorBase.AutoDispose
- Defined in mia/ts/client/classbase.ts:135

CommitValue

CommitValue(
    val: unknown,
    okcallback: (result: TCommitClassDataResult) => void,
    failurecallback?: (err: string) => void,
    status?: string,
    timestamp?: cDateTime,
): void
Commit Property Value / CurrentValue instance based on the accessor configuration. CurrentValue is used for historized properties and Variables showing CurrentValue, otherwise normal property change is done.
Parameters
- val: unknown
  The new value to commit.
- okcallback: (result: TCommitClassDataResult) => void
  Callback called when commit was done.
- Optionalfailurecallback: (err: string) => void
  Callback called when the commit failed.
- Optionalstatus: string
  Status field for the new value as hexadecimal numeric string, default "0x0". (Only for historized properties and Variable CurrentValues)
- Optionaltimestamp: cDateTime
  Time stamp for the new value. (Only for historized properties and Variable CurrentValues)
Returns void
- Defined in mia/ts/valueaccessors/currentvalueaccessor.ts:248

Dispose

Dispose(): void
Disposes the class object.

Returns void
Inherited from cSingleValueAccessorBase.Dispose
- Defined in mia/ts/client/classbase.ts:44

Get

Get<T>(propertyname: string): T
Get the value of a named property.
Type Parameters
- T
Parameters
- propertyname: string
  The name of the property
Returns T
Inherited from cSingleValueAccessorBase.Get
- Defined in mia/ts/componentbase/componentbase.ts:67

GetComponentClass

GetComponentClass(): string
Get the registered component class name

Returns string
See
Components.Add
Inherited from cSingleValueAccessorBase.GetComponentClass
- Defined in mia/ts/componentbase/componentbase.ts:73

GetContextItem

GetContextItem(): IContextItem
Get the data context item based on the accessor configuration.

Returns IContextItem
Overrides cSingleValueAccessorBase.GetContextItem
- Defined in mia/ts/valueaccessors/currentvalueaccessor.ts:350

GetTooltip

GetTooltip(): string
Get tooltip contents from the currently held value.

Returns string
Overrides cSingleValueAccessorBase.GetTooltip
- Defined in mia/ts/valueaccessors/currentvalueaccessor.ts:296

GetValueInfo

GetValueInfo(): string
Returns string
Inherited from cSingleValueAccessorBase.GetValueInfo
- Defined in mia/ts/valueaccessors/singlevalueaccessorbase.ts:61

IsDisposed

IsDisposed(): boolean
Gets the dispose state of the current class object.

Returns boolean
True, if the component is disposed.
Inherited from cSingleValueAccessorBase.IsDisposed
- Defined in mia/ts/client/classbase.ts:94

IsEqualTo

IsEqualTo(other: cCurrentValueAccessor): boolean
Compare the value accessor type and data configuration to another object.
Parameters
- other: cCurrentValueAccessor
  The other object to compare to.
Returns boolean
- Defined in mia/ts/valueaccessors/currentvalueaccessor.ts:339

IsInitialized

IsInitialized(): boolean
Accessor has benn initialized.

Returns boolean
Inherited from cSingleValueAccessorBase.IsInitialized
- Defined in mia/ts/valueaccessors/valueaccessorbase.ts:211

Set

Set<T>(propertyname: string, value: T): void
Set a value for the named property.
Type Parameters
- T
Parameters
- propertyname: string
  The name of the property
- value: T
  The new value for the property
Returns void
Inherited from cSingleValueAccessorBase.Set
- Defined in mia/ts/componentbase/componentbase.ts:82

toString

toString(): string
Returns string
See
ToString
Inherited from cSingleValueAccessorBase.toString
- Defined in mia/ts/componentbase/componentbase.ts:101

ToString

ToString(): string
String representation of the component instance. Can be overridden by inheriting classes.

Returns string
Inherited from cSingleValueAccessorBase.ToString
- Defined in mia/ts/componentbase/componentbase.ts:88

`Static`EnableListenerListeners

EnableListenerListeners(obj: cClassBase): void
Enable events for detecting when an event listener is added or removed
Parameters
- obj: cClassBase
  the class object to monitor
Returns void
Inherited from cSingleValueAccessorBase.EnableListenerListeners
- Defined in mia/ts/client/classbase.ts:180

Class cCurrentValueAccessor

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns cCurrentValueAccessor

Properties

ReadonlyAutoScaling

ReadonlyAutoScalingMode

ReadonlyChanged

ReadonlyConnection

ReadonlyContext

ReadonlyConvertTimeSpan

ReadonlyCustomDescription

ReadonlyCustomMaximumValue

ReadonlyCustomMinimumValue

ReadonlyCustomName

ReadonlyCustomUnit

ReadonlyDefaultStorage

ReadonlyDescription

ReadonlyDisplayName

ReadonlyDisposeEvent

ReadonlyEvents

ReadonlyInitialized

ReadonlyInitializeFailed

ReadonlyInstance

ReadonlyMaximumValue

ReadonlyMinimumValue

ReadonlyOwnerWidget

ReadonlyPathName

ReadonlyProperty

ReadonlyShowDescription

ReadonlyShowOwner

ReadonlySource

ReadonlyTooltipDecimals

ReadonlyUId

ReadonlyUnit

ReadonlyValue

ReadonlyValueRecord

Accessors

CanDispose

Returns boolean

Parameters

Returns void

NLS

Returns IComponentNLSRequest

Properties

Returns IPropertyAPI

Methods

Protected__initLegacyBase

Returns ILegacyBase

Abortable

Type Parameters

Parameters

Returns TAsyncAbortableReturn<TArgs>

ProtectedAddDisposeHandler

Parameters

Returns void

AutoDispose

Parameters

Returns void

CommitValue

Parameters

Returns void

Dispose

Returns void

Get

Type Parameters

Parameters

Returns T

GetComponentClass

Returns string

See

GetContextItem

Returns IContextItem

`Readonly`AutoScaling

`Readonly`AutoScalingMode

`Readonly`Changed

`Readonly`Connection

`Readonly`Context

`Readonly`ConvertTimeSpan

`Readonly`CustomDescription

`Readonly`CustomMaximumValue

`Readonly`CustomMinimumValue

`Readonly`CustomName

`Readonly`CustomUnit

`Readonly`DefaultStorage

`Readonly`Description

`Readonly`DisplayName

`Readonly`DisposeEvent

`Readonly`Events

`Readonly`Initialized

`Readonly`InitializeFailed

`Readonly`Instance

`Readonly`MaximumValue

`Readonly`MinimumValue

`Readonly`OwnerWidget

`Readonly`PathName

`Readonly`Property

`Readonly`ShowDescription

`Readonly`ShowOwner

`Readonly`Source

`Readonly`TooltipDecimals

`Readonly`UId

`Readonly`Unit

`Readonly`Value

`Readonly`ValueRecord

`Protected`__initLegacyBase

`Protected`AddDisposeHandler

`Static`EnableListenerListeners