node-opcua-address-space 2.180.0 → 2.181.0

package/src/ua_variable_impl.ts

@@ -1,2489 +0,0 @@
-/**
- * @module node-opcua-address-space
- */
-import { types } from "node:util";
-import chalk from "chalk";
-import type {
-    BindVariableOptions,
-    CloneFilter,
-    CloneOptions,
-    ISessionContext,
-    IVariableHistorian,
-    ListenerSignature,
-    TimestampGetFunc,
-    TimestampSetFunc,
-    UADataType,
-    UAVariable,
-    UAVariableEvents,
-    UAVariableType
-} from "node-opcua-address-space-base";
-import {
-    type BindExtensionObjectOptions,
-    type CloneExtraInfo,
-    type ContinuationData,
-    defaultCloneFilter,
-    type GetFunc,
-    makeDefaultCloneExtraInfo,
-    type SetFunc,
-    type VariableDataValueGetterSync,
-    type VariableDataValueSetterWithCallback,
-    type VariableSetter
-} from "node-opcua-address-space-base";
-import { assert } from "node-opcua-assert";
-import {
-    AccessLevelFlag,
-    AttributeIds,
-    convertAccessLevelFlagToByte,
-    isDataEncoding,
-    isValidDataEncoding,
-    makeAccessLevelFlag,
-    NodeClass,
-    type QualifiedName,
-    type QualifiedNameLike
-} from "node-opcua-data-model";
-import { DataValue, type DataValueLike, type DataValueT, extractRange, sameDataValue } from "node-opcua-data-value";
-import { coerceClock, getCurrentClock, type PreciseClock } from "node-opcua-date-time";
-import { checkDebugFlag, make_debugLog, make_errorLog, make_warningLog } from "node-opcua-debug";
-import { ExtensionObject, OpaqueStructure } from "node-opcua-extension-object";
-import { NodeId, type NodeIdLike } from "node-opcua-nodeid";
-import type { UAHistoricalDataConfiguration } from "node-opcua-nodeset-ua";
-import { NumericRange } from "node-opcua-numeric-range";
-import { WriteValue } from "node-opcua-service-write";
-import type { StatusCodeCallback } from "node-opcua-status-code";
-import { type CallbackT, StatusCode, StatusCodes } from "node-opcua-status-code";
-import {
-    type HistoryReadDetails,
-    HistoryReadResult,
-    PermissionType,
-    type ReadAtTimeDetails,
-    type ReadEventDetails,
-    type ReadProcessedDetails,
-    type ReadRawModifiedDetails,
-    type WriteValueOptions
-} from "node-opcua-types";
-import {
-    adjustVariant,
-    DataType,
-    sameVariant,
-    Variant,
-    VariantArrayType,
-    type VariantLike,
-    verifyRankAndDimensions
-} from "node-opcua-variant";
-import { convertToCallbackFunction1 } from "../source/helpers/multiform_func";
-import { SessionContext } from "../source/session_context";
-import { apply_condition_refresh, type ConditionRefreshCache } from "./apply_condition_refresh";
-import { BaseNodeImpl, type InternalBaseNodeOptions } from "./base_node_impl";
-import { _clone, ToStringBuilder, UAVariable_toString, valueRankToString } from "./base_node_private";
-import { adjustDataValueStatusCode } from "./data_access/adjust_datavalue_status_code";
-import { _getBasicDataType } from "./get_basic_datatype";
-import { type EnumerationInfo, type IEnumItem, UADataTypeImpl } from "./ua_data_type_impl";
-import {
-    _bindExtensionObject,
-    _bindExtensionObjectArrayOrMatrix,
-    _installExtensionObjectBindingOnProperties,
-    extractPartialData,
-    incrementElement,
-    propagateTouchValueDownward,
-    propagateTouchValueDownwardArray,
-    propagateTouchValueUpward,
-    setExtensionObjectPartialValue
-} from "./ua_variable_impl_ext_obj";
-import { validateDataTypeCorrectness } from "./validate_data_type_correctness";
-
-const debugLog = make_debugLog(__filename);
-const warningLog = make_warningLog(__filename);
-const doDebug = checkDebugFlag(__filename);
-const errorLog = make_errorLog(__filename);
-
-const plainChalk = new Proxy(chalk, { get: () => (s: string) => s }) as typeof chalk;
-
-export function adjust_accessLevel(accessLevel: string | number | AccessLevelFlag | null | undefined): AccessLevelFlag {
-    const flag = makeAccessLevelFlag(accessLevel ?? "CurrentRead | CurrentWrite");
-    assert(Number.isFinite(flag));
-    return flag;
-}
-
-export function adjust_userAccessLevel(
-    userAccessLevel: string | number | AccessLevelFlag | null | undefined,
-    accessLevel: string | number | AccessLevelFlag | null
-): AccessLevelFlag | undefined {
-    if (userAccessLevel === undefined) {
-        return undefined;
-    }
-    userAccessLevel = adjust_accessLevel(userAccessLevel);
-    accessLevel = adjust_accessLevel(accessLevel);
-    return makeAccessLevelFlag(accessLevel & userAccessLevel);
-}
-
-function adjust_samplingInterval(minimumSamplingInterval: number): number {
-    assert(Number.isFinite(minimumSamplingInterval));
-    if (minimumSamplingInterval < 0) {
-        return -1; // only -1 is a valid negative value for samplingInterval and means "unspecified"
-    }
-    return minimumSamplingInterval;
-}
-
-function is_Variant(v: unknown): boolean {
-    return v instanceof Variant;
-}
-
-function is_StatusCode(v: unknown): boolean {
-    return !!(
-        v?.constructor &&
-        (v instanceof StatusCode ||
-            v.constructor.name === "ConstantStatusCode" ||
-            v.constructor.name === "StatusCode" ||
-            v.constructor.name === "ModifiableStatusCode")
-    );
-}
-
-function is_Variant_or_StatusCode(v: unknown): boolean {
-    if (is_Variant(v)) {
-        // /@@assert(v.isValid());
-    }
-    return is_Variant(v) || is_StatusCode(v);
-}
-
-function default_func(this: UAVariable, dataValue1: DataValue, callback1: CallbackT<StatusCode>) {
-    return _default_writable_timestamped_set_func.call(this, dataValue1, callback1);
-}
-
-interface UAVariableOptions extends InternalBaseNodeOptions {
-    value?: unknown;
-    dataType: NodeId | string;
-    /**
-     * This attribute indicates whether the Value attribute of the Variable is an array and how many dimensions the array has.
-     * It may have the following values:
-     *   * n > 1: the Value is an array with the specified number of dimensions.
-     *   * OneDimension (1): The value is an array with one dimension.
-     *   * OneOrMoreDimensions (0): The value is an array with one or more dimensions.
-     *   * Scalar (−1): The value is not an array.
-     *   * Any (−2): The value can be a scalar or an array with any number of dimensions.
-     *   * ScalarOrOneDimension (−3): The value can be a scalar or a one dimensional array.
-     *   * All DataTypes are considered to be scalar, even if they have array-like semantics like ByteString and String.
-     */
-    valueRank?: number;
-    arrayDimensions?: null | number[];
-    accessLevel?: keyof typeof AccessLevelFlag | AccessLevelFlag | null;
-    userAccessLevel?: keyof typeof AccessLevelFlag | AccessLevelFlag | null;
-    minimumSamplingInterval?: number; // default -1
-    historizing?: boolean;
-}
-
-/**
- * A OPCUA Variable Node
- *
- * @class UAVariable
- * @constructor
- * @extends  BaseNode
- *  The AccessLevel Attribute is used to indicate how the Value of a Variable can be accessed (read/write) and if it
- *  contains current and/or historic data. The AccessLevel does not take any user access rights into account,
- *  i.e. although the Variable is writable this may be restricted to a certain user / user group.
- *  The AccessLevel is an 8-bit unsigned integer with the structure defined in the following table:
- *
- *  Field            Bit    Description
- *  CurrentRead      0      Indicates if the current value is readable
- *                          (0 means not readable, 1 means readable).
- *  CurrentWrite     1      Indicates if the current value is writable
- *                          (0 means not writable, 1 means writable).
- *  HistoryRead      2      Indicates if the history of the value is readable
- *                          (0 means not readable, 1 means readable).
- *  HistoryWrite     3      Indicates if the history of the value is writable (0 means not writable, 1 means writable).
- *  SemanticChange   4      Indicates if the Variable used as Property generates SemanticChangeEvents (see 9.31).
- *  Reserved         5:7    Reserved for future use. Shall always be zero.
- *
- *  The first two bits also indicate if a current value of this Variable is available and the second two bits
- *  indicates if the history of the Variable is available via the OPC UA server.
- *
- */
-export class UAVariableImpl<T extends UAVariableEvents & ListenerSignature<T> = UAVariableEvents>
-    extends BaseNodeImpl<T>
-    implements UAVariable<T>, UAVariableImplExtArray
-{
-    // -------------- UAvaraibleImplExArray
-    $$variableType?: UAVariableType;
-    $$dataType?: UADataType = undefined;
-    $$getElementBrowseName?: (extObject: ExtensionObject, index: number | number[]) => QualifiedName;
-    $$extensionObjectArray?: ExtensionObject[];
-    $$indexPropertyName?: string;
-    // --------------
-
-    public readonly nodeClass = NodeClass.Variable;
-
-    public dataType: NodeId;
-    private _basicDataType?: DataType;
-
-    // narrowing this to ExtensionObject breaks declaration-merging in ua_two_state_variable.ts and elsewhere
-    // (concrete *T variants bind $extensionObject to a different, more specific shape) — see the matching
-    // comment on UAVariable.$extensionObject in node-opcua-address-space-base for the documented precedent.
-    // biome-ignore lint/suspicious/noExplicitAny: see comment above
-    public $extensionObject?: any;
-    public $set_ExtensionObject?: (newValue: ExtensionObject, sourceTimestamp: PreciseClock, cache: Set<UAVariableImpl>) => void;
-
-    public $historicalDataConfiguration?: UAHistoricalDataConfiguration;
-    public varHistorian?: IVariableHistorian;
-
-    /**
-     * @internal @private
-     */
-    public $dataValue: DataValue;
-    public accessLevel: number;
-    public userAccessLevel?: number;
-    public valueRank: number;
-    public minimumSamplingInterval: number;
-    public historizing: boolean;
-    public semantic_version: number;
-    public arrayDimensions: null | number[];
-
-    public _timestamped_get_func?: TimestampGetFunc | null;
-    public _timestamped_set_func?: VariableDataValueSetterWithCallback | null;
-    public _get_func?: GetFunc | null;
-    public _set_func?: ((value: Variant, callback: (err: Error | null, statusCode?: StatusCode) => void) => void) | null;
-    public refreshFunc?: (callback: CallbackT<DataValue>) => void;
-    public __waiting_callbacks?: CallbackT<DataValue>[];
-
-    get typeDefinitionObj(): UAVariableType {
-        // c8 ignore next
-        if (super.typeDefinitionObj && super.typeDefinitionObj.nodeClass !== NodeClass.VariableType) {
-            // this could happen in faulty external nodeset and has been seen once
-            // in an nano server
-            warningLog(super.typeDefinitionObj.toString());
-            const baseVariableType = this.addressSpace.findVariableType("BaseVariableType");
-            if (!baseVariableType) throw new Error("Cannot find BaseVariableType in address space");
-            return baseVariableType;
-        }
-        return super.typeDefinitionObj as UAVariableType;
-    }
-    get typeDefinition(): NodeId {
-        return super.typeDefinition;
-    }
-    constructor(options: UAVariableOptions) {
-        super(options);
-
-        verifyRankAndDimensions(options);
-        this.valueRank = options.valueRank ?? -1;
-        this.arrayDimensions = options.arrayDimensions ?? null;
-
-        this.dataType = this.resolveNodeId(options.dataType); // DataType (NodeId)
-
-        this.accessLevel = adjust_accessLevel(options.accessLevel);
-
-        this.userAccessLevel = adjust_userAccessLevel(options.userAccessLevel, this.accessLevel);
-
-        this.minimumSamplingInterval = adjust_samplingInterval(options.minimumSamplingInterval || 0);
-
-        this.historizing = !!options.historizing; // coerced to boolean"
-
-        this.$dataValue = new DataValue({ statusCode: StatusCodes.UncertainInitialValue, value: { dataType: DataType.Null } });
-
-        if (options.value) {
-            this.bindVariable(options.value);
-        }
-
-        this.setMaxListeners(5000);
-
-        this.semantic_version = 0;
-    }
-    private checkAccessLevelPrivate(_context: ISessionContext, accessLevel: AccessLevelFlag): boolean {
-        if (this.userAccessLevel === undefined) {
-            return true;
-        }
-        return (this.userAccessLevel & accessLevel) === accessLevel;
-    }
-    private checkPermissionPrivate(context: ISessionContext, permission: PermissionType): boolean {
-        if (!context) return true;
-        assert(context instanceof SessionContext);
-        if (context.checkPermission) {
-            if (!(context.checkPermission instanceof Function)) {
-                errorLog("context checkPermission is not a function");
-                return false;
-            }
-            if (!context.checkPermission(this, permission)) {
-                return false;
-            }
-        }
-        return true;
-    }
-    private checkPermissionAndAccessLevelPrivate(
-        context: ISessionContext,
-        permission: PermissionType,
-        accessLevel: AccessLevelFlag
-    ): boolean {
-        if (!this.checkPermissionPrivate(context, permission)) {
-            return false;
-        }
-        return this.checkAccessLevelPrivate(context, accessLevel);
-    }
-
-    public isReadable(_context: ISessionContext): boolean {
-        return (this.accessLevel & AccessLevelFlag.CurrentRead) === AccessLevelFlag.CurrentRead;
-    }
-
-    public isUserReadable(context: ISessionContext): boolean {
-        if (!this.isReadable(context)) {
-            return false;
-        }
-        if (!this.checkPermissionPrivate(context, PermissionType.Read)) {
-            return false;
-        }
-        return this.checkAccessLevelPrivate(context, AccessLevelFlag.CurrentRead);
-    }
-
-    public isWritable(_context: ISessionContext): boolean {
-        return (this.accessLevel & AccessLevelFlag.CurrentWrite) === AccessLevelFlag.CurrentWrite;
-    }
-
-    public isUserWritable(context: ISessionContext): boolean {
-        if (!this.isWritable(context)) {
-            return false;
-        }
-        return this.checkPermissionAndAccessLevelPrivate(context, PermissionType.Write, AccessLevelFlag.CurrentWrite);
-    }
-
-    public canUserReadHistory(context: ISessionContext): boolean {
-        return this.checkPermissionAndAccessLevelPrivate(context, PermissionType.ReadHistory, AccessLevelFlag.HistoryRead);
-    }
-    public canUserWriteHistorizingAttribute(context: ISessionContext): boolean {
-        if (context && !context.checkPermission(this, PermissionType.WriteHistorizing)) {
-            return false;
-        }
-        return true;
-    }
-    public canUserInsertHistory(context: ISessionContext): boolean {
-        return this.checkPermissionAndAccessLevelPrivate(context, PermissionType.InsertHistory, AccessLevelFlag.HistoryWrite);
-    }
-    public canUserModifyHistory(context: ISessionContext): boolean {
-        return this.checkPermissionAndAccessLevelPrivate(context, PermissionType.ModifyHistory, AccessLevelFlag.HistoryWrite);
-    }
-    public canUserDeleteHistory(context: ISessionContext): boolean {
-        return this.checkPermissionAndAccessLevelPrivate(context, PermissionType.DeleteHistory, AccessLevelFlag.HistoryWrite);
-    }
-
-    /**
-     *
-     *
-     * from OPC.UA.Spec 1.02 part 4
-     *  5.10.2.4 StatusCodes
-     *  Table 51 defines values for the operation level statusCode contained in the DataValue structure of
-     *  each values element. Common StatusCodes are defined in Table 166.
-     *
-     * Table 51 Read Operation Level Result Codes
-     *
-     * | Symbolic Id                 | Description
-     * |-----------------------------|---------------------------------------------------------------------------------------------|
-     * |BadNodeIdInvalid             | The syntax of the node id is not valid.|
-     * |BadNodeIdUnknown            |The node id refers to a node that does not exist in the server address space.|
-     * |BadAttributeIdInvalid      | BadAttributeIdInvalid The attribute is not supported for the specified node.|
-     * |BadIndexRangeInvalid       | The syntax of the index range parameter is invalid.|
-     * |BadIndexRangeNoData        | No data exists within the range of indexes specified.|
-     * |BadDataEncodingInvalid     | The data encoding is invalid.|
-     * |                           | This result is used if no dataEncoding can be applied because an Attribute other|
-     * |                           | than Value was requested or the DataType of the Value Attribute is not a subtype|
-     * |                           | of the Structure DataType.|
-     * |BadDataEncodingUnsupported | The server does not support the requested data encoding for the node. |
-     * |                           | This result is used if a dataEncoding can be applied but the passed data encoding |
-     * |                           | is not known to the Server. |
-     * |BadNotReadable             | The access level does not allow reading or subscribing to the Node.|
-     * |BadUserAccessDenied        | User does not have permission to perform the requested operation. (table 165)|
-     */
-    public readValue(
-        context?: ISessionContext | null,
-        indexRange?: NumericRange,
-        dataEncoding?: QualifiedNameLike | null
-    ): DataValue {
-        if (!context) {
-            context = SessionContext.defaultContext;
-        }
-
-        if (context.isAccessRestricted(this)) {
-            return new DataValue({ statusCode: StatusCodes.BadSecurityModeInsufficient });
-        }
-
-        if (!this.isReadable(context)) {
-            return new DataValue({ statusCode: StatusCodes.BadNotReadable });
-        }
-        if (!this.checkPermissionPrivate(context, PermissionType.Read)) {
-            return new DataValue({ statusCode: StatusCodes.BadUserAccessDenied });
-        }
-        if (!this.isUserReadable(context)) {
-            return new DataValue({ statusCode: StatusCodes.BadNotReadable });
-        }
-        if (!isValidDataEncoding(dataEncoding)) {
-            return new DataValue({ statusCode: StatusCodes.BadDataEncodingInvalid });
-        }
-
-        if (this._timestamped_get_func) {
-            if (this._timestamped_get_func.length === 0) {
-                const dataValueOrPromise = (this._timestamped_get_func as VariableDataValueGetterSync)();
-                if (!Object.hasOwn(dataValueOrPromise.constructor.prototype, "then")) {
-                    if (dataValueOrPromise !== this.$dataValue) {
-                        // we may have a problem here if we use a getter that returns a dataValue that is a ExtensionObject
-                        if (dataValueOrPromise.value?.dataType === DataType.ExtensionObject) {
-                            if (this.$extensionObject || this.$$extensionObjectArray) {
-                                // we have an extension object already bound to this node
-                                // the client is asking us to replace the object entirely by a new one
-                                // const ext = dataValue.value.value;
-                                this._internal_set_dataValue(dataValueOrPromise);
-                                return dataValueOrPromise;
-                            }
-                        }
-
-                        // TO DO : is this necessary ? this may interfere with current use of $dataValue
-                        this.$dataValue = dataValueOrPromise as DataValue;
-                        if (this.$dataValue.statusCode.isGoodish()) {
-                            this.verifyVariantCompatibility(this.$dataValue.value);
-                        }
-                    }
-                } else {
-                    errorLog(
-                        "[NODE-OPCUA-E28] Unsupported: _timestamped_get_func returns a Promise ! , when the uaVariable has an async getter. Fix your application code."
-                    );
-                }
-            }
-        }
-
-        let dataValue = this.$dataValue;
-
-        if (dataValue.statusCode.isGoodish()) {
-            // note : extractRange will clone the dataValue
-            dataValue = extractRange(dataValue, indexRange);
-        }
-
-        /* c8 ignore next */
-        if (
-            dataValue.statusCode.equals(StatusCodes.BadWaitingForInitialData) ||
-            dataValue.statusCode.equals(StatusCodes.UncertainInitialValue)
-        ) {
-            // c8 ignore next
-            doDebug &&
-                debugLog(
-                    chalk.red(" Warning:  UAVariable#readValue ") +
-                        chalk.cyan(this.browseName.toString()) +
-                        " (" +
-                        chalk.yellow(this.nodeId.toString()) +
-                        ") exists but dataValue has not been defined"
-                );
-        }
-        return dataValue;
-    }
-
-    public isEnumeration(): boolean {
-        return this.addressSpacePrivate.isEnumeration(this.dataType);
-    }
-
-    /**
-     * return true if the DataType is of type Extension object
-     * this is not taking into account the valueRank of the variable
-     */
-    public isExtensionObject(): boolean {
-        // DataType must be one of Structure
-        if (this.dataType.isEmpty()) return false;
-        const dataTypeNode = this.addressSpace.findDataType(this.dataType) as UADataType;
-        if (!dataTypeNode) {
-            throw new Error(` Cannot find  DataType  ${this.dataType.toString()} in standard address Space`);
-        }
-        const structureNode = this.addressSpace.findDataType("Structure");
-        if (!structureNode) {
-            throw new Error(" Cannot find 'Structure' DataType in standard address Space");
-        }
-        return dataTypeNode.isSubtypeOf(structureNode);
-    }
-
-    public _getEnumerationInfo(): EnumerationInfo {
-        // DataType must be one of Enumeration
-        assert(this.isEnumeration(), "Variable is not an enumeration");
-        const dataTypeNode = this.addressSpace.findDataType(this.dataType) as UADataTypeImpl;
-        return dataTypeNode._getEnumerationInfo();
-    }
-
-    public asyncRefresh(oldestDate: PreciseClock, callback: CallbackT<DataValue>): void;
-    public asyncRefresh(oldestDate: PreciseClock): Promise<DataValue>;
-    public asyncRefresh(oldestDate: PreciseClock, callback?: CallbackT<DataValue>): Promise<DataValue> | undefined {
-        // asyncRefresh is always invoked with a callback at runtime: the public overload without
-        // a callback is only reachable through the withCallback() wrapper installed below, which
-        // synthesizes one before calling into this implementation.
-        const cb = callback as CallbackT<DataValue>;
-        if (this.$dataValue.statusCode.isGoodish()) {
-            this.verifyVariantCompatibility(this.$dataValue.value);
-        }
-
-        const lessOrEqual = (a: PreciseClock, b: PreciseClock) => {
-            return (
-                a.timestamp.getTime() < b.timestamp.getTime() ||
-                (a.timestamp.getTime() === b.timestamp.getTime() && a.picoseconds <= b.picoseconds)
-            );
-        };
-
-        if (!this.refreshFunc) {
-            // no refresh func
-            const dataValue = this.readValue();
-            dataValue.serverTimestamp = oldestDate.timestamp;
-            dataValue.serverPicoseconds = oldestDate.picoseconds;
-            const serverClock = coerceClock(dataValue.serverTimestamp, dataValue.serverPicoseconds);
-            if (lessOrEqual(oldestDate, serverClock)) {
-                cb(null, dataValue);
-                return;
-            } else {
-                // fake
-                cb(null, dataValue);
-                return;
-            }
-        }
-
-        const c1 = this.$dataValue.serverTimestamp
-            ? coerceClock(this.$dataValue.serverTimestamp, this.$dataValue.serverPicoseconds)
-            : null;
-
-        if (c1 && lessOrEqual(oldestDate, c1)) {
-            const dataValue = this.readValue().clone();
-            dataValue.serverTimestamp = oldestDate.timestamp;
-            dataValue.serverPicoseconds = oldestDate.picoseconds;
-            cb(null, dataValue);
-            return;
-        }
-        try {
-            this.refreshFunc.call(this, (err: Error | null, dataValue?: DataValueLike) => {
-                // c8 ignore next
-                if (err || !dataValue) {
-                    errorLog(
-                        "-------------- refresh call failed",
-                        this.browseName.toString(),
-                        this.nodeId.toString(),
-                        err?.message
-                    );
-                    dataValue = { statusCode: StatusCodes.BadNoDataAvailable };
-                }
-                if (dataValue && dataValue !== this.$dataValue) {
-                    this._internal_set_dataValue(coerceDataValue(dataValue), null);
-                }
-                cb(err, this.$dataValue);
-            });
-        } catch (err) {
-            errorLog("-------------- refresh call failed 2", this.browseName.toString(), this.nodeId.toString());
-            errorLog(err);
-            const dataValue = new DataValue({ statusCode: StatusCodes.BadInternalError });
-            this._internal_set_dataValue(dataValue, null);
-            cb(err as Error, this.$dataValue);
-        }
-        return undefined;
-    }
-
-    public readEnumValue(): IEnumItem {
-        const value = this.readValue().value.value as number;
-        const enumInfo = this._getEnumerationInfo();
-        const enumV = enumInfo.valueIndex[value];
-        return { value, name: enumV ? enumV.name : "?????" };
-    }
-
-    public writeEnumValue(value: string | number): void {
-        const enumInfo = this._getEnumerationInfo();
-
-        if (typeof value === "string") {
-            if (!Object.hasOwn(enumInfo.nameIndex, value)) {
-                const possibleValues = Object.keys(enumInfo.nameIndex).join(",");
-                throw new Error(`UAVariable#writeEnumValue: cannot find value ${value} in [${possibleValues}]`);
-            }
-            const valueIndex = enumInfo.nameIndex[value].value;
-            value = valueIndex;
-        }
-        if (Number.isFinite(value)) {
-            const possibleValues = Object.keys(enumInfo.nameIndex).join(",");
-
-            if (!enumInfo.valueIndex[value]) {
-                throw new Error(`UAVariable#writeEnumValue : value out of range ${value} in [${possibleValues}]`);
-            }
-            this.setValueFromSource({
-                dataType: DataType.Int32,
-                value
-            });
-        } else {
-            throw new Error("UAVariable#writeEnumValue:  value type mismatch");
-        }
-    }
-
-    public readAttribute(
-        context: ISessionContext | null,
-        attributeId: AttributeIds,
-        indexRange?: NumericRange,
-        dataEncoding?: QualifiedNameLike | null
-    ): DataValue {
-        context = context || SessionContext.defaultContext;
-        assert(context instanceof SessionContext);
-
-        const options: DataValueLike = {};
-
-        if (attributeId !== AttributeIds.Value) {
-            if (indexRange?.isDefined()) {
-                options.statusCode = StatusCodes.BadIndexRangeNoData;
-                return new DataValue(options);
-            }
-            if (isDataEncoding(dataEncoding)) {
-                options.statusCode = StatusCodes.BadDataEncodingInvalid;
-                return new DataValue(options);
-            }
-        }
-
-        switch (attributeId) {
-            case AttributeIds.Value:
-                return this.readValue(context, indexRange, dataEncoding);
-
-            case AttributeIds.DataType:
-                return this._readDataType();
-
-            case AttributeIds.ValueRank:
-                return this._readValueRank();
-
-            case AttributeIds.ArrayDimensions:
-                return this._readArrayDimensions();
-
-            case AttributeIds.AccessLevel:
-                return this._readAccessLevel(context);
-
-            case AttributeIds.UserAccessLevel:
-                return this._readUserAccessLevel(context);
-
-            case AttributeIds.MinimumSamplingInterval:
-                return this._readMinimumSamplingInterval();
-
-            case AttributeIds.Historizing:
-                return this._readHistorizing();
-
-            case AttributeIds.AccessLevelEx:
-                return this._readAccessLevelEx(context);
-            default:
-                return BaseNodeImpl.prototype.readAttribute.call(this, context, attributeId);
-        }
-    }
-
-    public getBasicDataType(): DataType {
-        return _getBasicDataType(this);
-    }
-    public adjustVariant(variant: Variant): Variant {
-        return adjustVariant(variant, this.valueRank, this.getBasicDataType());
-    }
-    public verifyVariantCompatibility(variant: Variant): void {
-        try {
-            // c8 ignore next
-            if (Object.hasOwn(variant, "value")) {
-                if (variant.dataType === null || variant.dataType === undefined) {
-                    throw new Error(
-                        "Variant must provide a valid dataType : variant = " +
-                            variant.toString() +
-                            " this.dataType= " +
-                            this.dataType.toString()
-                    );
-                }
-                if (
-                    variant.dataType === DataType.Boolean &&
-                    (this.dataType.namespace !== 0 || this.dataType.value !== DataType.Boolean)
-                ) {
-                    throw new Error(
-                        "Variant must provide a valid Boolean : variant = " +
-                            variant.toString() +
-                            " this.dataType= " +
-                            this.dataType.toString()
-                    );
-                }
-                if (
-                    this.dataType.namespace === 0 &&
-                    this.dataType.value === DataType.LocalizedText &&
-                    variant.dataType !== DataType.LocalizedText &&
-                    variant.dataType !== DataType.Null
-                ) {
-                    throw new Error(
-                        "Variant must provide a valid LocalizedText : variant = " +
-                            variant.toString() +
-                            " this.dataType= " +
-                            this.dataType.toString()
-                    );
-                }
-            }
-            const basicType = this.getBasicDataType();
-
-            if (basicType === DataType.String && variant.dataType === DataType.ByteString) {
-                return; // this is allowed
-            }
-            if (basicType === DataType.ByteString && variant.dataType === DataType.String) {
-                return; // this is allowed
-            }
-
-            if (
-                basicType !== DataType.Null &&
-                basicType !== DataType.Variant &&
-                variant.dataType !== DataType.Null &&
-                variant.dataType !== basicType
-            ) {
-                const message =
-                    "UAVariable.setValueFromSource " +
-                    this.browseName.toString() +
-                    " nodeId:" +
-                    this.nodeId.toString() +
-                    " dataType:" +
-                    this.dataType.toString() +
-                    ":\n" +
-                    "the provided variant must have the expected dataType!\n" +
-                    "   - the expected dataType is " +
-                    chalk.cyan(DataType[basicType]) +
-                    "\n" +
-                    "   - the actual dataType   is " +
-                    chalk.magenta(DataType[variant.dataType]) +
-                    "\n" +
-                    "   - " +
-                    variant.toString();
-                throw new Error(message);
-            }
-        } catch (err) {
-            errorLog("UAVariable  ", (err as Error)?.message, this.browseName.toString(), " nodeId=", this.nodeId.toString());
-            errorLog((err as Error).message);
-            errorLog((err as Error).stack);
-            throw err;
-        }
-    }
-    /**
-     * setValueFromSource is used to let the device sets the variable values
-     * this method also records the current time as sourceTimestamp and serverTimestamp.
-.     *
-    * The method will raise an exception if the value is not compatible with the dataType and expected dimension
-    *
-
-    * @param variant  {Variant}
-    * @param [statusCode  {StatusCode} = StatusCodes.Good]
-    * @param [sourceTimestamp= Now]
-    */
-    public setValueFromSource(variant: VariantLike, statusCode?: StatusCode, sourceTimestamp?: Date): void {
-        try {
-            statusCode = statusCode || StatusCodes.Good;
-            const variant1 = Variant.coerce(variant);
-            this.verifyVariantCompatibility(variant1);
-            const now = coerceClock(sourceTimestamp, 0);
-
-            const dataValue = new DataValue(null);
-            dataValue.serverPicoseconds = now.picoseconds;
-            dataValue.serverTimestamp = now.timestamp;
-            dataValue.sourcePicoseconds = now.picoseconds;
-            dataValue.sourceTimestamp = now.timestamp;
-            dataValue.statusCode = statusCode;
-            dataValue.value = variant1;
-
-            if (dataValue.value.dataType === DataType.ExtensionObject) {
-                // early, detailed diagnostics on a malformed extension object (the actual throw
-                // happens below in _internal_set_dataValue).
-                const valueIsCorrect = this.checkExtensionObjectIsCorrect(dataValue.value.value);
-                if (!valueIsCorrect) {
-                    errorLog("setValueFromSource Invalid value !");
-                    errorLog(this.toString());
-                    errorLog(dataValue.toString());
-                }
-            }
-            // Route every value - scalar or ExtensionObject - through _internal_set_dataValue.
-            // This guarantees the change is consistently propagated to observers (historian,
-            // monitored items) and, when the node is a bound extension object (or a bound
-            // sub-structure child), cascaded through the proxy field setters by the overridden
-            // _inner_replace_dataValue. Previously ExtensionObject values were special-cased with a
-            // silent "this.$dataValue = dataValue" assignment that skipped notification for plain
-            // (unbound) extension object variables and threw on bound sub-structure children.
-            this._internal_set_dataValue(dataValue);
-        } catch (err) {
-            errorLog("UAVariable#setValueFromString Error : ", this.browseName.toString(), this.nodeId.toString());
-            errorLog((err as Error).message);
-            errorLog(this.parent?.toString());
-            throw err;
-        }
-    }
-
-    private adjustDataValueStatusCode(dataValue: DataValue): StatusCode {
-        const statusCode = adjustDataValueStatusCode(
-            this,
-            dataValue,
-            (this as unknown as { acceptValueOutOfRange?: boolean }).acceptValueOutOfRange || false
-        );
-        return statusCode;
-    }
-
-    public writeValue(
-        context: ISessionContext,
-        dataValue: DataValue,
-        indexRange: string | NumericRange | null,
-        callback: StatusCodeCallback
-    ): void;
-    public writeValue(context: ISessionContext, dataValue: DataValue, callback: StatusCodeCallback): void;
-    public writeValue(
-        context: ISessionContext,
-        dataValue: DataValue,
-        indexRange?: string | NumericRange | null
-    ): Promise<StatusCode>;
-    public writeValue(context: ISessionContext, dataValue: DataValue, ...args: unknown[]): Promise<StatusCode> | undefined {
-        context = context || SessionContext.defaultContext;
-        assert(context instanceof SessionContext);
-
-        if (!dataValue.sourceTimestamp) {
-            // source timestamp was not specified by the caller
-            // we will set the timestamp ourself with the current clock
-            if (context.currentTime) {
-                dataValue.sourceTimestamp = context.currentTime.timestamp;
-                dataValue.sourcePicoseconds = context.currentTime.picoseconds;
-            } else {
-                const { timestamp, picoseconds } = getCurrentClock();
-                dataValue.sourceTimestamp = timestamp;
-                dataValue.sourcePicoseconds = picoseconds;
-            }
-        }
-
-        if (context.currentTime && !dataValue.serverTimestamp) {
-            dataValue.serverTimestamp = context.currentTime.timestamp;
-            dataValue.serverPicoseconds = context.currentTime.picoseconds;
-        }
-
-        // adjust arguments if optional indexRange Parameter is not given
-        let indexRange: NumericRange | null = null;
-        let callback: StatusCodeCallback;
-        if (args.length === 1) {
-            indexRange = new NumericRange();
-            callback = args[0] as StatusCodeCallback;
-        } else if (args.length === 2) {
-            indexRange = args[0] as NumericRange;
-            callback = args[1] as StatusCodeCallback;
-        } else {
-            throw new Error("Invalid Number of args");
-        }
-
-        assert(typeof callback === "function");
-        assert(dataValue instanceof DataValue);
-        // index range could be string
-        indexRange = NumericRange.coerce(indexRange);
-
-        // test write permission
-        if (!this.isWritable(context)) {
-            callback?.(null, StatusCodes.BadNotWritable);
-            return;
-        }
-        if (!this.checkPermissionPrivate(context, PermissionType.Write)) {
-            callback?.(null, StatusCodes.BadUserAccessDenied);
-            return;
-        }
-
-        if (!this.isUserWritable(context)) {
-            callback?.(null, StatusCodes.BadWriteNotSupported);
-            return;
-        }
-
-        // adjust special case
-        const variant = adjustVariant2.call(this, dataValue.value);
-
-        const statusCode = this.checkVariantCompatibility(variant);
-        if (statusCode.isNot(StatusCodes.Good)) {
-            callback?.(null, statusCode);
-            return;
-        }
-
-        // adjust dataValue.statusCode based on InstrumentRange and EngineeringUnits
-        const statusCode2 = this.adjustDataValueStatusCode(dataValue);
-        if (statusCode2.isNotGood()) {
-            callback?.(null, statusCode2);
-            return;
-        }
-
-        const write_func = this._timestamped_set_func || default_func;
-
-        if (!write_func) {
-            warningLog(` warning ${this.nodeId.toString()} ${this.browseName.toString()} has no setter. \n`);
-            warningLog("Please make sure to bind the variable or to pass a valid value: new Variant({}) during construction time");
-            callback?.(null, StatusCodes.BadNotWritable);
-            return;
-        }
-        assert(write_func);
-
-        write_func.call(this, dataValue, (err?: Error | null, statusCode1?: StatusCode) => {
-            if (!err) {
-                dataValue && this.verifyVariantCompatibility(dataValue.value);
-
-                if (indexRange && !indexRange.isEmpty()) {
-                    if (!indexRange.isValid()) {
-                        callback?.(null, StatusCodes.BadIndexRangeInvalid);
-                        return;
-                    }
-
-                    const newArrayOrMatrix = dataValue.value.value;
-
-                    if (dataValue.value.arrayType === VariantArrayType.Array) {
-                        if (this.$dataValue.value.arrayType !== VariantArrayType.Array) {
-                            callback(null, StatusCodes.BadTypeMismatch);
-                            return;
-                        }
-                        // check that destination data is also an array
-                        assert(check_valid_array(this.$dataValue.value.dataType, this.$dataValue.value.value));
-                        const destArr = this.$dataValue.value.value;
-                        const result = indexRange.set_values(destArr, newArrayOrMatrix);
-
-                        if (result.statusCode.isNot(StatusCodes.Good)) {
-                            callback?.(null, result.statusCode);
-                            return;
-                        }
-                        dataValue.value.value = result.array;
-
-                        // scrap original array so we detect range
-                        this.$dataValue.value.value = null;
-                    } else if (dataValue.value.arrayType === VariantArrayType.Matrix) {
-                        const dimensions = this.$dataValue.value.dimensions;
-                        if (this.$dataValue.value.arrayType !== VariantArrayType.Matrix || !dimensions) {
-                            // not a matrix !
-                            callback?.(null, StatusCodes.BadTypeMismatch);
-                            return;
-                        }
-                        const matrix = this.$dataValue.value.value;
-                        const result = indexRange.set_values_matrix(
-                            {
-                                matrix,
-                                dimensions
-                            },
-                            newArrayOrMatrix
-                        );
-                        if (result.statusCode.isNot(StatusCodes.Good)) {
-                            callback?.(null, result.statusCode);
-                            return;
-                        }
-                        dataValue.value.dimensions = this.$dataValue.value.dimensions;
-                        dataValue.value.value = result.matrix;
-
-                        // scrap original array so we detect range
-                        this.$dataValue.value.value = null;
-                    } else {
-                        callback?.(null, StatusCodes.BadTypeMismatch);
-                        return;
-                    }
-                }
-                try {
-                    this._internal_set_dataValue(dataValue, indexRange);
-                } catch (err) {
-                    if (types.isNativeError(err)) {
-                        warningLog(err.message);
-                    }
-                    callback?.(null, StatusCodes.BadInternalError);
-                    return;
-                }
-            }
-            callback?.(err || null, statusCode1);
-        });
-        return undefined;
-    }
-
-    public writeAttribute(context: ISessionContext | null, writeValue: WriteValueOptions, callback: StatusCodeCallback): void;
-    public writeAttribute(context: ISessionContext | null, writeValue: WriteValueOptions): Promise<StatusCode>;
-    public writeAttribute(
-        context: ISessionContext | null,
-        writeValueOptions: WriteValueOptions,
-        callback?: (err: Error | null, statusCode?: StatusCode) => void
-    ): Promise<StatusCode> | undefined {
-        // c8 ignore next
-        if (!callback) {
-            throw new Error("Internal error");
-        }
-
-        if (!this.canUserWriteAttribute(context, writeValueOptions.attributeId as AttributeIds)) {
-            callback(null, StatusCodes.BadUserAccessDenied);
-            return;
-        }
-        const writeValue: WriteValue =
-            writeValueOptions instanceof WriteValue ? (writeValueOptions as WriteValue) : new WriteValue(writeValueOptions);
-
-        context = context || SessionContext.defaultContext;
-
-        assert(context instanceof SessionContext);
-        assert(writeValue instanceof WriteValue);
-        assert(writeValue.value instanceof DataValue);
-        assert(writeValue.value?.value instanceof Variant);
-        assert(typeof callback === "function");
-
-        // Spec 1.0.2 Part 4 page 58
-        // If the SourceTimestamp or the ServerTimestamp is specified, the Server shall
-        // use these values.
-
-        // xx _apply_default_timestamps(writeValue.value);
-
-        switch (writeValue.attributeId) {
-            case AttributeIds.Value:
-                this.writeValue(context, writeValue.value as DataValue, writeValue.indexRange, callback);
-                break;
-            case AttributeIds.Historizing:
-                if (writeValue.value?.value.dataType !== DataType.Boolean) {
-                    callback(null, StatusCodes.BadTypeMismatch);
-                    break;
-                }
-                if (!this.checkPermissionPrivate(context, PermissionType.WriteHistorizing)) {
-                    callback(null, StatusCodes.BadUserAccessDenied);
-                    break;
-                }
-
-                if (!this.canUserWriteHistorizingAttribute(context)) {
-                    callback(null, StatusCodes.BadHistoryOperationUnsupported);
-                    break;
-                }
-
-                // if the variable has no historizing in place reject
-                if (!this.getChildByName("HA Configuration")) {
-                    callback(null, StatusCodes.BadNotSupported);
-                    break;
-                }
-                // check if user is allowed to do that !
-                // TODO
-                this.historizing = !!writeValue.value?.value.value; // yes ! indeed !
-                callback(null, StatusCodes.Good);
-                break;
-
-            default:
-                super.writeAttribute(context, writeValue, callback);
-                break;
-        }
-        return undefined;
-    }
-
-    /**
-
-     * note:
-     *     this method is overridden in address-space-data-access
-     * @return {StatusCode}
-     */
-    public checkVariantCompatibility(value: Variant): StatusCode {
-        // test dataType
-        if (!this._validate_DataType(value.dataType)) {
-            return StatusCodes.BadTypeMismatch;
-        }
-        try {
-            this.verifyVariantCompatibility(value);
-        } catch (_err) {
-            return StatusCodes.BadTypeMismatch;
-        }
-        return StatusCodes.Good;
-    }
-
-    /**
-     * touch the source timestamp of a Variable and cascade up the change
-     * to the parent variable if any.
-     */
-    public touchValue(optionalNow?: PreciseClock): void {
-        const now = optionalNow || getCurrentClock();
-        propagateTouchValueUpward(this, now);
-    }
-
-    /**
-     * bind a variable with a get and set functions.
-     *
-     *  properties:
-     *    - value: a Variant or a status code
-     *    - sourceTimestamp
-     *    - sourcePicoseconds
-     * @param [options.timestamped_set]
-     * @param [options.refreshFunc]      the variable asynchronous getter function.
-     * @param [overwrite {Boolean} = false] set overwrite to true to overwrite existing binding
-     * @return void
-     *
-     *
-     * ### Providing read access to the underlying value
-     *
-     * #### Variation 1
-     *
-     * In this variation, the user provides a function that returns a Variant with the current value.
-     *
-     * The sourceTimestamp will be set automatically.
-     *
-     * The get function is called synchronously.
-     *
-     * @example
-     *
-     *
-     * ```javascript
-     *     ...
-     *     var options =  {
-     *       get : () => {
-     *          return new Variant({...});
-     *       },
-     *       set : function(variant) {
-     *          // store the variant somewhere
-     *          return StatusCodes.Good;
-     *       }
-     *    };
-     *    ...
-     *    engine.bindVariable(nodeId,options):
-     *    ...
-     * ```
-     *
-     *
-     * #### Variation 2:
-     *
-     * This variation can be used when the user wants to specify a specific '''sourceTimestamp''' associated
-     * with the current value of the UAVariable.
-     *
-     * The provided ```timestamped_get``` function should return an object with three properties:
-     * * value: containing the variant value or a error StatusCode,
-     * * sourceTimestamp
-     * * sourcePicoseconds
-     *
-     * ```javascript
-     * ...
-     * var myDataValue = new DataValue({
-     *   value: {dataType: DataType.Double , value: 10.0},
-     *   sourceTimestamp : new Date(),
-     *   sourcePicoseconds: 0
-     * });
-     * ...
-     * var options =  {
-     *   timestamped_get : () => { return myDataValue;  }
-     * };
-     * ...
-     * engine.bindVariable(nodeId,options):
-     * ...
-     * // record a new value
-     * myDataValue.value.value = 5.0;
-     * myDataValue.sourceTimestamp = new Date();
-     * ...
-     * ```
-     *
-     *
-     * #### Variation 3:
-     *
-     * This variation can be used when the value associated with the variables requires a asynchronous function call to be
-     * extracted. In this case, the user should provide an async method ```refreshFunc```.
-     *
-     *
-     * The ```refreshFunc``` shall do whatever is necessary to fetch the most up to date version of the variable value, and
-     * call the ```callback``` function when the data is ready.
-     *
-     *
-     * The ```callback``` function follow the standard callback function signature:
-     * * the first argument shall be **null** or **Error**, depending of the outcome of the fetch operation,
-     * * the second argument shall be a DataValue with the new UAVariable Value,  a StatusCode, and time stamps.
-     *
-     *
-     * Optionally, it is possible to pass a sourceTimestamp and a sourcePicoseconds value as a third and fourth arguments
-     * of the callback. When sourceTimestamp and sourcePicoseconds are missing, the system will set their default value
-     * to the current time..
-     *
-     *
-     * ```javascript
-     * ...
-     * var options =  {
-     *    refreshFunc : function(callback) {
-     *      ... do_some_async_stuff_to_get_the_new_variable_value
-     *      var dataValue = new DataValue({
-     *          value: new Variant({...}),
-     *          statusCode: StatusCodes.Good,
-     *          sourceTimestamp: new Date()
-     *      });
-     *      callback(null,dataValue);
-     *    }
-     * };
-     * ...
-     * variable.bindVariable(nodeId,options):
-     * ...
-     * ```
-     *
-     * ### Providing write access to the underlying value
-     *
-     * #### Variation1 - provide a simple synchronous set function
-     *
-     *
-     * #### Notes
-     *   to do : explain return StatusCodes.GoodCompletesAsynchronously;
-     *
-     */
-    public bindVariable(options?: BindVariableOptions, overwrite?: boolean): void {
-        if (overwrite) {
-            this._timestamped_set_func = null;
-            this._timestamped_get_func = null;
-            this._get_func = null;
-            this._set_func = null;
-            this.refreshFunc = undefined;
-            this._historyRead = UAVariableImpl.prototype._historyRead;
-        }
-
-        options = options || {};
-
-        assert(typeof this._timestamped_set_func !== "function", "UAVariable already bound");
-        assert(typeof this._timestamped_get_func !== "function", "UAVariable already bound");
-
-        bind_getter.call(this, options);
-        bind_setter.call(this, options);
-
-        const _historyRead = options.historyRead;
-        if (_historyRead) {
-            assert(typeof this._historyRead !== "function" || this._historyRead === UAVariableImpl.prototype._historyRead);
-            assert(typeof _historyRead === "function");
-
-            this._historyRead = _historyRead;
-            assert(this._historyRead.length === 6);
-        }
-        // post conditions
-        assert(typeof this._timestamped_set_func === "function");
-        assert(this._timestamped_set_func?.length === 2, "expecting 2 parameters");
-    }
-
-    /**
-
-     */
-    public readValueAsync(context: ISessionContext | null, callback: CallbackT<DataValue>): void;
-    public readValueAsync(context: ISessionContext | null): Promise<DataValue>;
-    public readValueAsync(context: ISessionContext | null, callback?: CallbackT<DataValue>): Promise<DataValue> | undefined {
-        assert(typeof callback === "function");
-
-        context = context || SessionContext.defaultContext;
-
-        this.__waiting_callbacks = this.__waiting_callbacks || [];
-        this.__waiting_callbacks.push(callback as CallbackT<DataValue>);
-
-        const _readValueAsync_in_progress = this.__waiting_callbacks.length >= 2;
-        if (_readValueAsync_in_progress) {
-            return;
-        }
-
-        if (this.isDisposed()) {
-            callback?.(null, new DataValue({ statusCode: StatusCodes.BadNodeIdUnknown }));
-            return;
-        }
-
-        const readImmediate = (innerCallback: (err: Error | null, dataValue: DataValue) => void) => {
-            assert(this.$dataValue instanceof DataValue);
-            const dataValue = this.readValue(context);
-            innerCallback(null, dataValue);
-        };
-
-        let func: (innerCallback: (err: Error | null, dataValue: DataValue) => void) => void;
-
-        const answerStatusOnly = (statusCode: StatusCode) => (innerCallback: (err: Error | null, dataValue: DataValue) => void) =>
-            innerCallback(null, new DataValue({ statusCode }));
-
-        if (context.isAccessRestricted(this)) {
-            // same gate as readValue(): a variable bound with a simple get()
-            // also gets a refreshFunc, sending every read down the asyncRefresh
-            // branch below - which calls the getter directly and never passes
-            // through readValue(). Without this check here, a node hardened
-            // with AccessRestrictions(EncryptionRequired) answered its value
-            // over an unencrypted channel.
-            func = answerStatusOnly(StatusCodes.BadSecurityModeInsufficient);
-        } else if (!this.isReadable(context)) {
-            func = answerStatusOnly(StatusCodes.BadNotReadable);
-        } else if (!this.checkPermissionPrivate(context, PermissionType.Read)) {
-            func = answerStatusOnly(StatusCodes.BadUserAccessDenied);
-        } else if (!this.isUserReadable(context)) {
-            func = answerStatusOnly(StatusCodes.BadNotReadable);
-        } else {
-            const clock = getCurrentClock();
-            func = typeof this.refreshFunc === "function" ? this.asyncRefresh.bind(this, clock) : readImmediate;
-        }
-
-        const satisfy_callbacks = (err: Error | null, dataValue?: DataValue) => {
-            // now call all pending callbacks
-            const callbacks = this.__waiting_callbacks || [];
-            this.__waiting_callbacks = [];
-            const _n = callbacks.length;
-            for (const callback1 of callbacks) {
-                callback1.call(this, err, dataValue);
-            }
-        };
-
-        try {
-            func.call(this, satisfy_callbacks);
-        } catch (err) {
-            // c8 ignore next
-            if (doDebug) {
-                debugLog(chalk.red("func readValueAsync has failed "));
-                if (types.isNativeError(err)) {
-                    debugLog(" stack", err.stack);
-                }
-            }
-            satisfy_callbacks(err as Error);
-        }
-        return undefined;
-    }
-
-    public getWriteMask(): number {
-        return super.getWriteMask();
-    }
-
-    public getUserWriteMask(): number {
-        return super.getUserWriteMask();
-    }
-
-    public clone(options: CloneOptions, optionalFilter?: CloneFilter, extraInfo?: CloneExtraInfo): UAVariable {
-        options = {
-            ...options,
-            // check this eventNotifier: this.eventNotifier,
-            // check this symbolicName: this.symbolicName,
-
-            accessLevel: this.accessLevel,
-            arrayDimensions: this.arrayDimensions,
-            dataType: this.dataType,
-            historizing: this.historizing,
-            minimumSamplingInterval: this.minimumSamplingInterval,
-            userAccessLevel: this.userAccessLevel,
-            valueRank: this.valueRank
-        };
-
-        const newVariable = _clone(
-            this,
-            UAVariableImpl<T>,
-            options,
-            optionalFilter || defaultCloneFilter,
-            extraInfo || makeDefaultCloneExtraInfo(this)
-        ) as UAVariableImpl<T>;
-
-        newVariable.bindVariable();
-
-        assert(typeof newVariable._timestamped_set_func === "function");
-
-        assert(newVariable.dataType === this.dataType);
-        newVariable.$dataValue = this.$dataValue.clone();
-
-        // also bind extension object
-        const v = newVariable.$dataValue.value;
-        if (v.dataType === DataType.ExtensionObject && v.value && v.arrayType === VariantArrayType.Scalar) {
-            try {
-                newVariable.bindExtensionObject(newVariable.$dataValue.value.value);
-            } catch (err) {
-                errorLog("Error binding extension objects");
-                errorLog((err as Error).message);
-                errorLog(this.toString());
-                errorLog("---------------------------------------");
-                errorLog(this.$dataValue.toString());
-                errorLog("---------------------------------------");
-                errorLog(newVariable.$dataValue.toString());
-                throw err;
-            }
-        }
-        return newVariable;
-    }
-
-    public getDataTypeNode(): UADataType {
-        const addressSpace = this.addressSpace;
-        if (this.dataType.isEmpty()) {
-            this.dataType = this.resolveNodeId(DataType.Variant);
-        }
-        const dt = addressSpace.findNode(this.dataType);
-        // c8 ignore next
-        if (!dt) {
-            throw new Error(`getDataTypeNode: cannot find dataType ${this.dataType.toString()}`);
-        }
-        return dt as UADataType;
-    }
-
-    public get dataTypeObj(): UADataType {
-        return this.getDataTypeNode();
-    }
-
-    public checkExtensionObjectIsCorrect(extObj: ExtensionObject | ExtensionObject[] | null): boolean {
-        if (!extObj) {
-            return true;
-        }
-        const addressSpace = this.addressSpace;
-        if (!addressSpace) {
-            return true;
-        }
-        const dataType = addressSpace.findDataType(this.dataType);
-        if (!dataType) {
-            // may be we are in the process of loading a xml file and the corresponding dataType
-            // has not yet been loaded !
-            return true;
-        }
-        if (dataType.nodeId.namespace === 0 && dataType.nodeId.value === DataType.ExtensionObject) {
-            return true;
-        }
-        const Constructor = addressSpace.getExtensionObjectConstructor(this.dataType);
-
-        if (this.valueRank === -1) {
-            /** Scalar */
-            if (Array.isArray(extObj)) {
-                return false;
-            }
-            return checkExtensionObjectIsCorrectScalar.call(this, extObj);
-        } else if (this.valueRank >= 1) {
-            /** array */
-            if (!Array.isArray(extObj)) {
-                // let's coerce this scalar into an 1-element array if it is a valid extension object
-                if (checkExtensionObjectIsCorrectScalar.call(this, extObj)) {
-                    warningLog(
-                        `warning: checkExtensionObjectIsCorrect : expecting a array but got a scalar (value rank of '${this.browseName.toString()}' is 1)\nautomatic conversion from scalar to array with 1 element is taking place.`
-                    );
-                    extObj = [extObj];
-                } else {
-                    return false;
-                }
-            }
-            return checkExtensionObjectIsCorrectArray.call(this, extObj);
-        } else if (this.valueRank === 0) {
-            // Scalar or Array
-            const isCorrectScalar = !Array.isArray(extObj) && checkExtensionObjectIsCorrectScalar.call(this, extObj);
-            const isCorrectArray =
-                Array.isArray(extObj) && checkExtensionObjectIsCorrectArray.call(this, extObj as ExtensionObject[]);
-            return isCorrectArray || isCorrectScalar;
-        } else {
-            throw new Error(
-                `checkExtensionObjectIsCorrect: Not Implemented case, please contact sterfive : this.valueRank =${this.valueRank}`
-            );
-        }
-        function checkExtensionObjectIsCorrectScalar(this: UAVariableImpl, extObj: ExtensionObject | null): boolean {
-            // c8 ignore next
-            if (!extObj?.constructor) {
-                errorLog(extObj);
-                throw new Error("expecting an valid extension object");
-            }
-
-            if (extObj.constructor.name === Constructor.name) {
-                return true;
-            }
-
-            if (extObj instanceof OpaqueStructure) {
-                throw new Error("An opaque structure is not expected here");
-            }
-            // let's verify that the constructor is a sub-class of Constructor
-            let current: IStructuredTypeSchema | null = extObj.schema;
-            while (current) {
-                if (current.name === Constructor.name) {
-                    return true;
-                }
-                current = current.getBaseSchema();
-            }
-            return false;
-        }
-
-        function checkExtensionObjectIsCorrectArray(this: UAVariableImpl, extObjArray: ExtensionObject[]): boolean {
-            // c8 ignore next
-            for (const extObj of extObjArray) {
-                if (!extObj?.constructor) {
-                    errorLog(extObj);
-                    throw new Error("expecting an valid extension object");
-                }
-            }
-            try {
-                for (const e of extObjArray) {
-                    if (!e) {
-                        continue;
-                    }
-                    if (e.constructor.name !== Constructor.name) {
-                        // c8 ignore next
-                        doDebug && debugLog("extObj.constructor.name ", e.constructor.name, "expected", Constructor.name);
-                        return false;
-                    }
-                }
-                return true;
-            } catch (err) {
-                errorLog(err);
-                return false;
-            }
-        }
-    }
-
-    public changeDataType(newDataType: NodeIdLike, newValue?: VariantLike): void {
-        changeUAVariableDataType(this, newDataType, newValue);
-    }
-
-    /**
-     * @private
-     * install UAVariable to exposed th
-     *
-     * precondition:
-     */
-    public installExtensionObjectVariables(): void {
-        _installExtensionObjectBindingOnProperties(this, { createMissingProp: true });
-    }
-    /**
-
-     * @return {ExtensionObject}
-     */
-    public bindExtensionObjectScalar(
-        optionalExtensionObject?: ExtensionObject,
-        options?: BindExtensionObjectOptions
-    ): ExtensionObject | null {
-        assert(this.valueRank === -1, "expecting an Scalar variable here");
-        return _bindExtensionObject(this, optionalExtensionObject, options) as ExtensionObject;
-    }
-
-    public bindExtensionObjectArray(
-        optionalExtensionObject?: ExtensionObject[],
-        options?: BindExtensionObjectOptions
-    ): ExtensionObject[] | null {
-        assert(this.valueRank >= 1, "expecting an Array or a Matrix variable here");
-        return _bindExtensionObjectArrayOrMatrix(this, optionalExtensionObject, options);
-    }
-
-    public bindExtensionObject(
-        optionalExtensionObject?: ExtensionObject | ExtensionObject[],
-        options?: BindExtensionObjectOptions
-    ): ExtensionObject | ExtensionObject[] | null {
-        // coerce to ExtensionObject[] when this.valueRank === 1
-        if (
-            optionalExtensionObject &&
-            this.valueRank === 1 &&
-            !Array.isArray(optionalExtensionObject) &&
-            optionalExtensionObject instanceof ExtensionObject
-        ) {
-            warningLog(
-                "bindExtensionObject: coerce to ExtensionObject[] when valueRank === 1 and value is a scalar extension object"
-            );
-            optionalExtensionObject = [optionalExtensionObject];
-        }
-
-        if (optionalExtensionObject) {
-            if (Array.isArray(optionalExtensionObject)) {
-                assert(this.valueRank >= 1, "bindExtensionObject: expecting an Array of Matrix variable here");
-                return _bindExtensionObjectArrayOrMatrix(this, optionalExtensionObject, options);
-            } else {
-                if (this.valueRank !== -1 && this.valueRank !== 0) {
-                    throw new Error(`bindExtensionObject: expecting an Scalar variable here but got value rank ${this.valueRank}`);
-                }
-                return _bindExtensionObject(this, optionalExtensionObject, options) as ExtensionObject;
-            }
-        }
-        assert(optionalExtensionObject === undefined || optionalExtensionObject === null);
-        if (this.valueRank === -1) {
-            return _bindExtensionObject(this, undefined, options) as ExtensionObject;
-        } else if (this.valueRank === 1) {
-            return _bindExtensionObjectArrayOrMatrix(this, undefined, options);
-        } else if (this.valueRank > 1) {
-            return _bindExtensionObjectArrayOrMatrix(this, undefined, options);
-        }
-        //  unsupported case ...
-        return null;
-    }
-
-    public updateExtensionObjectPartial(partialExtensionObject?: Record<string, unknown>): ExtensionObject {
-        setExtensionObjectPartialValue(this, partialExtensionObject);
-        return this.$extensionObject as ExtensionObject;
-    }
-
-    public incrementExtensionObjectPartial(path: string | string[]): void {
-        const extensionObject = this.readValue().value.value as ExtensionObject;
-        const partialData = extractPartialData(path, extensionObject);
-        incrementElement(path, partialData);
-        setExtensionObjectPartialValue(this, partialData);
-    }
-
-    public toString(): string {
-        const options = new ToStringBuilder();
-        UAVariable_toString.call(this, options);
-        return options.toString();
-    }
-
-    public toJSON(): Record<string, unknown> {
-        let value: unknown;
-        let statusCode: string | undefined;
-        try {
-            const dv = this.$dataValue;
-            if (dv) {
-                statusCode = dv.statusCode?.toString();
-                if (dv.value && !(dv.value.value instanceof OpaqueStructure)) {
-                    value = dv.value.value;
-                }
-            }
-        } catch {
-            // ignore — value access may fail for bound variables
-        }
-        return {
-            ...super.toJSON(),
-            typeDefinition: this.typeDefinitionObj?.browseName.toString(),
-            dataType: this.dataType?.toString(),
-            valueRank: this.valueRank,
-            arrayDimensions: this.arrayDimensions,
-            accessLevel: AccessLevelFlag[this.accessLevel],
-            statusCode,
-            value
-        };
-    }
-
-    public [Symbol.for("nodejs.util.inspect.custom")](depth: number | null, inspectOptions: { colors?: boolean }): string {
-        const c = inspectOptions?.colors === false ? plainChalk : chalk;
-        const typeName = this.typeDefinitionObj?.browseName.toString() ?? "?";
-        const displayName = this.displayName.length ? this.displayName.map((d) => d.text).join(" | ") : "";
-        if (depth !== null && depth <= 0) {
-            return `${c.cyan("UAVariable<")}${c.green(this.browseName.toString())}${c.grey(` ${this.nodeId.toString()}`)}${c.cyan(">")}`;
-        }
-        const dt = this.dataType?.toString() ?? "?";
-        let valueStr = "";
-        let statusStr = "";
-        try {
-            const dv = this.$dataValue;
-            if (dv) {
-                if (dv.statusCode) statusStr = dv.statusCode.toString();
-                if (
-                    dv.value &&
-                    dv.value.value !== undefined &&
-                    dv.value.value !== null &&
-                    !(dv.value.value instanceof OpaqueStructure)
-                ) {
-                    const v = dv.value.value;
-                    valueStr = typeof v === "object" ? Object.prototype.toString.call(v) : String(v);
-                    if (valueStr.length > 80) valueStr = `${valueStr.slice(0, 77)}...`;
-                }
-            }
-        } catch {
-            // ignore
-        }
-        const lines = [
-            `${c.cyan("UAVariable ")}${c.green(this.browseName.toString())}${c.grey(` ${this.nodeId.toString()}`)}`,
-            c.yellow("  typeDefinition : ") + typeName,
-            c.yellow("  displayName    : ") + displayName,
-            c.yellow("  dataType       : ") + dt,
-            c.yellow("  valueRank      : ") + valueRankToString(this.valueRank),
-            c.yellow("  accessLevel    : ") + AccessLevelFlag[this.accessLevel]
-        ];
-        if (this.arrayDimensions?.length) {
-            lines.push(c.yellow("  arrayDimensions: ") + JSON.stringify(this.arrayDimensions));
-        }
-        if (valueStr) {
-            lines.push(c.yellow("  value          : ") + valueStr);
-        }
-        if (statusStr && statusStr !== "Good (0x00000000)") {
-            lines.push(c.yellow("  statusCode     : ") + statusStr);
-        }
-        if (this.description?.text) {
-            lines.push(c.yellow("  description    : ") + this.description.text);
-        }
-        return lines.join("\n");
-    }
-
-    // ---------------------------------------------------------------------------------------------------
-    // History
-    // ---------------------------------------------------------------------------------------------------
-
-    public historyRead(
-        context: ISessionContext,
-        historyReadDetails:
-            | HistoryReadDetails
-            | ReadRawModifiedDetails
-            | ReadEventDetails
-            | ReadProcessedDetails
-            | ReadAtTimeDetails,
-        indexRange: NumericRange | null,
-        dataEncoding: QualifiedNameLike | null,
-        continuationData: ContinuationData
-    ): Promise<HistoryReadResult>;
-
-    public historyRead(
-        context: ISessionContext,
-        historyReadDetails:
-            | HistoryReadDetails
-            | ReadRawModifiedDetails
-            | ReadEventDetails
-            | ReadProcessedDetails
-            | ReadAtTimeDetails,
-        indexRange: NumericRange | null,
-        dataEncoding: QualifiedNameLike | null,
-        continuationData: ContinuationData,
-        callback: CallbackT<HistoryReadResult>
-    ): void;
-    public historyRead(
-        context: ISessionContext,
-        historyReadDetails:
-            | HistoryReadDetails
-            | ReadRawModifiedDetails
-            | ReadEventDetails
-            | ReadProcessedDetails
-            | ReadAtTimeDetails,
-        indexRange: NumericRange | null,
-        dataEncoding: QualifiedNameLike | null,
-        continuationData: ContinuationData,
-        callback?: CallbackT<HistoryReadResult>
-    ): Promise<HistoryReadResult> | undefined {
-        assert(context instanceof SessionContext);
-        assert(typeof callback === "function");
-        if (typeof this._historyRead !== "function") {
-            callback?.(null, new HistoryReadResult({ statusCode: StatusCodes.BadNotReadable }));
-            return;
-        }
-
-        this._historyRead(
-            context,
-            historyReadDetails,
-            indexRange,
-            dataEncoding,
-            continuationData,
-            callback as CallbackT<HistoryReadResult>
-        );
-        return undefined;
-    }
-
-    public _historyReadRaw(
-        _context: ISessionContext,
-        _historyReadRawModifiedDetails: ReadRawModifiedDetails,
-        _indexRange: NumericRange | null,
-        _dataEncoding: QualifiedNameLike | null,
-        _continuationData: ContinuationData,
-        _callback: CallbackT<HistoryReadResult>
-    ): void {
-        throw new Error("");
-    }
-
-    public _historyReadRawModify(
-        _context: ISessionContext,
-        _historyReadRawModifiedDetails: ReadRawModifiedDetails,
-        _indexRange: NumericRange | null,
-        _dataEncoding: QualifiedNameLike | null,
-        _continuationData: ContinuationData,
-        _callback?: CallbackT<HistoryReadResult>
-    ): void {
-        throw new Error("");
-    }
-
-    public _historyRead(
-        context: ISessionContext,
-        _historyReadDetails:
-            | HistoryReadDetails
-            | ReadRawModifiedDetails
-            | ReadEventDetails
-            | ReadProcessedDetails
-            | ReadAtTimeDetails,
-        _indexRange: NumericRange | null,
-        _dataEncoding: QualifiedNameLike | null,
-        _continuationData: ContinuationData,
-        callback: CallbackT<HistoryReadResult>
-    ): void {
-        if (!this.checkPermissionPrivate(context, PermissionType.ReadHistory)) {
-            const result = new HistoryReadResult({
-                statusCode: StatusCodes.BadUserAccessDenied
-            });
-            callback(null, result);
-        }
-        if (!this.canUserReadHistory(context)) {
-            const result = new HistoryReadResult({
-                statusCode: StatusCodes.BadHistoryOperationUnsupported
-            });
-            callback(null, result);
-        }
-        const result = new HistoryReadResult({
-            statusCode: StatusCodes.BadHistoryOperationUnsupported
-        });
-        callback(null, result);
-    }
-
-    public _historyPush(_newDataValue: DataValue): void {
-        throw new Error("");
-    }
-
-    public _historyReadRawAsync(
-        _historyReadRawModifiedDetails: ReadRawModifiedDetails,
-        _maxNumberToExtract: number,
-        _isReversed: boolean,
-        _reverseDataValue: boolean,
-        _callback: CallbackT<DataValue[]>
-    ): void {
-        throw new Error("");
-    }
-
-    public _historyReadModify(
-        _context: ISessionContext,
-        _historyReadRawModifiedDetails: ReadRawModifiedDetails,
-        _indexRange: NumericRange | null,
-        _dataEncoding: QualifiedNameLike | null,
-        _continuationData: ContinuationData,
-        _callback: CallbackT<HistoryReadResult>
-    ): void {
-        throw new Error("");
-    }
-
-    public _update_startOfOnlineArchive(_newDate: Date): void {
-        // please install
-        throw new Error("");
-    }
-
-    public _update_startOfArchive(_newDate: Date): void {
-        throw new Error("");
-    }
-
-    public _validate_DataType(variantDataType: DataType): boolean {
-        return validateDataTypeCorrectness(this.addressSpace, this.dataType, variantDataType, /* allow Nulls */ false, this.nodeId);
-    }
-
-    public _internal_set_value(value: Variant): void {
-        if (value.dataType !== DataType.Null) {
-            this.verifyVariantCompatibility(value);
-        }
-        this.$dataValue.value = value;
-    }
-
-    public _internal_set_dataValue(dataValue: DataValue, indexRange?: NumericRange | null): void {
-        assert(dataValue, "expecting a dataValue");
-        assert(dataValue instanceof DataValue, "expecting dataValue to be a DataValue");
-        assert(dataValue !== this.$dataValue, "expecting dataValue to be different from previous DataValue instance");
-
-        const addressSpace = this.addressSpace;
-
-        // c8 ignore next
-        if (!addressSpace) {
-            warningLog("UAVariable#_internal_set_dataValue : no addressSpace ! may be node has already been deleted ?");
-            return;
-        }
-
-        // c8 ignore next
-        if (dataValue.value.arrayType === VariantArrayType.Matrix) {
-            if (!dataValue.value.dimensions) {
-                throw new Error("missing dimensions: a Matrix Variant needs a dimension");
-            }
-            const nbElements = dataValue.value.dimensions.reduce((acc, x) => acc * x, 1);
-            if (dataValue.value.value.length !== 0 && dataValue.value.value.length !== nbElements) {
-                throw new Error(
-                    `Internal Error: matrix dimension doesn't match the number of element in the array : ${dataValue.toString()} "\n expecting ${nbElements} elements but got ${
-                        dataValue.value.value.length
-                    }`
-                );
-            }
-        }
-
-        // c8 ignore next
-        if (dataValue.value.dataType === DataType.ExtensionObject) {
-            // c8 ignore next
-            if (!this.checkExtensionObjectIsCorrect(dataValue.value.value)) {
-                warningLog(dataValue.toString());
-                throw new Error(`Invalid Extension Object on nodeId =${this.nodeId.toString()}`);
-            }
-        }
-
-        this.verifyVariantCompatibility(dataValue.value);
-
-        this._inner_replace_dataValue(dataValue, indexRange);
-    }
-
-    /**
-     * @private
-     */
-    public _inner_replace_dataValue(dataValue: DataValue, indexRange?: NumericRange | null) {
-        assert(this.$dataValue.value instanceof Variant);
-        const old_dataValue = this.$dataValue.clone();
-
-        if (this.$$extensionObjectArray && dataValue.value.arrayType !== VariantArrayType.Scalar) {
-            // we have a bounded array or matrix
-            assert(Array.isArray(dataValue.value.value));
-            if (this.$$extensionObjectArray !== this.$dataValue.value.value) {
-                throw new Error("internal error");
-            }
-            this.$$extensionObjectArray = dataValue.value.value;
-            this.$dataValue.value.value = dataValue.value.value;
-
-            this.$dataValue.statusCode = dataValue.statusCode || StatusCodes.Good;
-            this.$dataValue.serverTimestamp = dataValue.serverTimestamp;
-            this.$dataValue.serverPicoseconds = dataValue.serverPicoseconds;
-            this.$dataValue.sourceTimestamp = dataValue.sourceTimestamp;
-            this.$dataValue.sourcePicoseconds = dataValue.sourcePicoseconds;
-        } else if (
-            this._basicDataType === DataType.ExtensionObject &&
-            this.valueRank === -1 &&
-            this.$set_ExtensionObject &&
-            dataValue.value.arrayType === VariantArrayType.Scalar
-        ) {
-            // the entire extension object is changed.
-            this.$dataValue.statusCode = this.$dataValue.statusCode || StatusCodes.Good;
-            const preciseClock = coerceClock(this.$dataValue.sourceTimestamp, this.$dataValue.sourcePicoseconds);
-            this.$set_ExtensionObject(dataValue.value.value, preciseClock, new Set());
-        } else {
-            this.$dataValue = dataValue;
-            this.$dataValue.statusCode = this.$dataValue.statusCode || StatusCodes.Good;
-        }
-        // repair missing timestamps
-        const now = new Date();
-        if (!dataValue.serverTimestamp) {
-            this.$dataValue.serverTimestamp = old_dataValue.serverTimestamp || now;
-            this.$dataValue.serverPicoseconds = old_dataValue.serverPicoseconds || 0;
-        }
-        if (!dataValue.sourceTimestamp) {
-            this.$dataValue.sourceTimestamp = old_dataValue.sourceTimestamp || now;
-            this.$dataValue.sourcePicoseconds = old_dataValue.sourcePicoseconds || 0;
-        }
-
-        if (!sameDataValue(old_dataValue, dataValue)) {
-            if (this.getBasicDataType() === DataType.ExtensionObject) {
-                const preciseClock = coerceClock(this.$dataValue.sourceTimestamp, this.$dataValue.sourcePicoseconds);
-                const cache: Set<UAVariable> = new Set();
-                if (this.$$extensionObjectArray) {
-                    this.touchValue(preciseClock);
-                    propagateTouchValueDownwardArray(this, preciseClock, cache);
-                } else {
-                    this.touchValue(preciseClock);
-                    propagateTouchValueDownward(this, preciseClock, cache);
-                }
-            } else {
-                (this as UAVariable).emit("value_changed", this.$dataValue.clone(), indexRange);
-            }
-        }
-    }
-
-    public _conditionRefresh(_cache?: ConditionRefreshCache): void {
-        apply_condition_refresh.call(this, _cache);
-    }
-
-    public handle_semantic_changed(_dataValue: DataValue): void {
-        this.semantic_version = this.semantic_version + 1;
-        (this as UAVariable).emit("semantic_changed");
-    }
-
-    private _readDataType(): DataValue {
-        assert(this.dataType instanceof NodeId);
-        const options = {
-            statusCode: StatusCodes.Good,
-            value: {
-                dataType: DataType.NodeId,
-                value: this.dataType
-            }
-        };
-        return new DataValue(options);
-    }
-
-    private _readValueRank(): DataValue {
-        assert(typeof this.valueRank === "number");
-        const options = {
-            statusCode: StatusCodes.Good,
-            value: { dataType: DataType.Int32, value: this.valueRank }
-        };
-        return new DataValue(options);
-    }
-
-    private _readArrayDimensions(): DataValue {
-        assert(Array.isArray(this.arrayDimensions) || this.arrayDimensions === null);
-        assert(!this.arrayDimensions || this.valueRank > 0, "arrayDimension must be null if valueRank <0");
-        const options = {
-            statusCode: StatusCodes.Good,
-            value: { dataType: DataType.UInt32, arrayType: VariantArrayType.Array, value: this.arrayDimensions }
-        };
-        return new DataValue(options);
-    }
-
-    private _readAccessLevel(context: ISessionContext): DataValue {
-        assert(context instanceof SessionContext);
-        const options = {
-            statusCode: StatusCodes.Good,
-            value: { dataType: DataType.Byte, value: convertAccessLevelFlagToByte(this.accessLevel) }
-        };
-        return new DataValue(options);
-    }
-
-    private _readAccessLevelEx(context: ISessionContext): DataValue {
-        assert(context instanceof SessionContext);
-        const options = {
-            statusCode: StatusCodes.Good,
-            // Extra flags are not supported yet. to do:
-            value: { dataType: DataType.UInt32, value: convertAccessLevelFlagToByte(this.accessLevel) }
-        };
-        return new DataValue(options);
-    }
-
-    private _readUserAccessLevel(context: ISessionContext): DataValue {
-        assert(context instanceof SessionContext);
-
-        const effectiveUserAccessLevel = _calculateEffectiveUserAccessLevelFromPermission(this, context, this.userAccessLevel);
-
-        const options = {
-            value: {
-                dataType: DataType.Byte,
-                statusCode: StatusCodes.Good,
-                value: convertAccessLevelFlagToByte(effectiveUserAccessLevel)
-            }
-        };
-        return new DataValue(options);
-    }
-
-    private _readMinimumSamplingInterval(): DataValue {
-        // expect a Duration => Double
-        const options: DataValueLike = {};
-        if (this.minimumSamplingInterval === undefined) {
-            options.statusCode = StatusCodes.BadAttributeIdInvalid;
-        } else {
-            options.value = { dataType: DataType.Double, value: this.minimumSamplingInterval };
-            options.statusCode = StatusCodes.Good;
-        }
-        return new DataValue(options);
-    }
-
-    private _readHistorizing(): DataValue {
-        assert(typeof this.historizing === "boolean");
-        const options = {
-            statusCode: StatusCodes.Good,
-            value: { dataType: DataType.Boolean, value: !!this.historizing }
-        };
-        return new DataValue(options);
-    }
-}
-
-import type { IStructuredTypeSchema } from "node-opcua-factory";
-import { withCallback } from "thenify-ex";
-
-UAVariableImpl.prototype.asyncRefresh = withCallback(UAVariableImpl.prototype.asyncRefresh);
-UAVariableImpl.prototype.writeValue = withCallback(UAVariableImpl.prototype.writeValue);
-UAVariableImpl.prototype.writeAttribute = withCallback(UAVariableImpl.prototype.writeAttribute);
-UAVariableImpl.prototype.historyRead = withCallback(UAVariableImpl.prototype.historyRead);
-UAVariableImpl.prototype.readValueAsync = withCallback(UAVariableImpl.prototype.readValueAsync);
-
-export interface UAVariableImplExtArray {
-    $$variableType?: UAVariableType;
-    $$dataType?: UADataType;
-    $$getElementBrowseName?: (extObject: ExtensionObject, index: number | number[]) => QualifiedName;
-    $$extensionObjectArray?: ExtensionObject[];
-    $$indexPropertyName?: string;
-}
-
-function check_valid_array(dataType: DataType, array: unknown): boolean {
-    if (Array.isArray(array)) {
-        return true;
-    }
-    switch (dataType) {
-        case DataType.Double:
-            return array instanceof Float64Array;
-        case DataType.Float:
-            return array instanceof Float32Array;
-        case DataType.Int32:
-            return array instanceof Int32Array;
-        case DataType.Int16:
-            return array instanceof Int16Array;
-        case DataType.SByte:
-            return array instanceof Int8Array;
-        case DataType.UInt32:
-            return array instanceof Uint32Array;
-        case DataType.UInt16:
-            return array instanceof Uint16Array;
-        case DataType.Byte:
-            return array instanceof Uint8Array || array instanceof Buffer;
-    }
-    return false;
-}
-
-// function _apply_default_timestamps(dataValue: DataValue): void {
-//     const now = getCurrentClock();
-//     assert(dataValue instanceof DataValue);
-
-//     if (!dataValue.sourceTimestamp) {
-//         dataValue.sourceTimestamp = now.timestamp;
-//         dataValue.sourcePicoseconds = now.picoseconds;
-//     }
-//     if (!dataValue.serverTimestamp) {
-//         dataValue.serverTimestamp = now.timestamp;
-//         dataValue.serverPicoseconds = now.picoseconds;
-//     }
-// }
-
-function unsetFlag(flags: number, mask: number): number {
-    return flags & ~mask;
-}
-function _setFlag(flags: number, mask: number): number {
-    return flags | mask;
-}
-
-function _calculateEffectiveUserAccessLevelFromPermission(
-    node: UAVariable,
-    context: ISessionContext,
-    userAccessLevel: AccessLevelFlag | undefined
-): AccessLevelFlag {
-    function __adjustFlag(
-        permissionType: PermissionType,
-        access: AccessLevelFlag,
-        userAccessLevel1: AccessLevelFlag
-    ): AccessLevelFlag {
-        if ((node.accessLevel & access) === 0 || (userAccessLevel1 & access) === 0) {
-            userAccessLevel1 = unsetFlag(userAccessLevel1, access);
-        } else {
-            if (!context.checkPermission(node, permissionType)) {
-                userAccessLevel1 = unsetFlag(userAccessLevel1, access);
-            }
-        }
-        return userAccessLevel1;
-    }
-    userAccessLevel = node.userAccessLevel === undefined ? node.accessLevel : node.userAccessLevel & node.accessLevel;
-    if (context.checkPermission) {
-        assert(context.checkPermission instanceof Function);
-        userAccessLevel = __adjustFlag(PermissionType.Read, AccessLevelFlag.CurrentRead, userAccessLevel);
-        userAccessLevel = __adjustFlag(PermissionType.Write, AccessLevelFlag.CurrentWrite, userAccessLevel);
-        userAccessLevel = __adjustFlag(PermissionType.Write, AccessLevelFlag.StatusWrite, userAccessLevel);
-        userAccessLevel = __adjustFlag(PermissionType.Write, AccessLevelFlag.TimestampWrite, userAccessLevel);
-        userAccessLevel = __adjustFlag(PermissionType.ReadHistory, AccessLevelFlag.HistoryRead, userAccessLevel);
-        userAccessLevel = __adjustFlag(PermissionType.DeleteHistory, AccessLevelFlag.HistoryWrite, userAccessLevel);
-        return userAccessLevel;
-    } else {
-        return userAccessLevel;
-    }
-}
-
-function adjustVariant2(this: UAVariableImpl, variant: Variant): Variant {
-    // convert Variant( Scalar|ByteString) =>  Variant(Array|ByteArray)
-    const _addressSpace = this.addressSpace;
-    const basicType = this.getBasicDataType();
-    variant = adjustVariant(variant, this.valueRank, basicType);
-    return variant;
-}
-
-function _not_writable_timestamped_set_func(
-    dataValue: DataValue,
-    callback: (err: Error | null, statusCode: StatusCode, dataValue?: DataValue | null) => void
-) {
-    assert(dataValue instanceof DataValue);
-    callback(null, StatusCodes.BadNotWritable, null);
-}
-
-function _default_writable_timestamped_set_func(
-    dataValue: DataValue,
-    callback: (err: Error | null, statusCode: StatusCode, dataValue?: DataValue | null) => void
-) {
-    assert(dataValue instanceof DataValue);
-    callback(null, StatusCodes.Good, dataValue);
-}
-
-type f1<T, D, R> = (this: T, data: D) => R;
-type f2<T, D, R> = (this: T, data: D) => Promise<R>;
-type f3<T, D, R> = (this: T, data: D, callback: (err: Error | null, r?: R) => void) => void;
-
-function turn_sync_to_async<T, D, R>(f: f1<T, D, R> | f2<T, D, R> | f3<T, D, R>, numberOfArgs: number): f3<T, D, R> {
-    if (f.length <= numberOfArgs) {
-        return function (this: T, data: D, callback: (err: Error | null, r?: R) => void) {
-            new Promise<R>((resolve, reject) => {
-                try {
-                    // const ff1 = f as f1<T, D, R>;
-                    const ff2 = f as f2<T, D, R>;
-                    const r: R | Promise<R> = ff2.call(this, data);
-                    if (r instanceof Promise) {
-                        r.then(resolve, reject);
-                    } else {
-                        resolve(r);
-                    }
-                } catch (err) {
-                    reject(err);
-                }
-            })
-                .then((r) => {
-                    callback(null, r);
-                })
-                .catch((err) => {
-                    callback(err as Error);
-                });
-        };
-    } else {
-        assert(f.length === numberOfArgs + 1);
-        return f;
-    }
-}
-
-const _default_minimumSamplingInterval = 1000;
-
-function coerceDataValue(dataValue: DataValue | DataValueLike): DataValue {
-    if (dataValue instanceof DataValue) {
-        return dataValue;
-    }
-    return new DataValue(dataValue);
-}
-
-// variation #3 :
-function _Variable_bind_with_async_refresh(
-    this: UAVariableImpl,
-    options: { refreshFunc: RefreshFunc; get?: undefined; timestamped_get?: undefined }
-) {
-    assert(this instanceof UAVariableImpl);
-
-    assert(typeof options.refreshFunc === "function");
-    assert(!options.get, "a getter shall not be specified when refreshFunc is set");
-    assert(!options.timestamped_get, "a getter shall not be specified when refreshFunc is set");
-
-    assert(!this.refreshFunc);
-
-    this.refreshFunc = options.refreshFunc;
-    /*
-    // TO DO : REVISIT THIS ASSUMPTION
-    if (false && this.minimumSamplingInterval === 0) {
-        // when a getter /timestamped_getter or async_getter is provided
-        // samplingInterval cannot be 0, as the item value must be scanned to be updated.
-        this.minimumSamplingInterval = _default_minimumSamplingInterval; // MonitoredItem.minimumSamplingInterval;
-        // c8 ignore next
-        doDebug && debugLog(`adapting minimumSamplingInterval on ${this.browseName.toString()} to ${this.minimumSamplingInterval}`);
-    }
-        */
-}
-
-// variation 2
-function _Variable_bind_with_timestamped_get(
-    this: UAVariableImpl,
-    options: {
-        get: undefined;
-        timestamped_get: TimestampGetFunc;
-    }
-) {
-    /* jshint validthis: true */
-    assert(this instanceof UAVariableImpl);
-    assert(typeof options.timestamped_get === "function");
-    assert(!options.get, "should not specify 'get' when 'timestamped_get' exists ");
-    assert(!this._timestamped_get_func);
-
-    const async_refresh_func = (callback: (err: Error | null, dataValue?: DataValue) => void) => {
-        Promise.resolve((this._timestamped_get_func as VariableDataValueGetterSync).call(this))
-            .then((dataValue) => callback(null, dataValue))
-            .catch((err) => {
-                errorLog("asyncRefresh error: Variable is  ", this.nodeId.toString(), this.browseName.toString());
-                callback(err as Error);
-            });
-    };
-    const pThis = this as UAVariable;
-    if (options.timestamped_get.length === 0) {
-        const timestamped_get = options.timestamped_get as (this: UAVariable) => DataValue | Promise<DataValue>;
-        // sync version | Promise version
-        this._timestamped_get_func = timestamped_get;
-
-        const dataValue_verify = timestamped_get.call(pThis);
-        // dataValue_verify should be a DataValue or a Promise
-        /* c8 ignore next */
-        if (!(dataValue_verify instanceof DataValue) && typeof dataValue_verify.then !== "function") {
-            errorLog(
-                chalk.red(" Bind variable error: "),
-                " the timestamped_get function must return a DataValue or a Promise<DataValue>" +
-                    "\n value_check.constructor.name ",
-                dataValue_verify ? dataValue_verify.constructor.name : "null"
-            );
-
-            throw new Error(" Bind variable error: " + " the timestamped_get function must return a DataValue");
-        }
-        _Variable_bind_with_async_refresh.call(this, { refreshFunc: async_refresh_func });
-    } else if (options.timestamped_get.length === 1) {
-        _Variable_bind_with_async_refresh.call(this, { refreshFunc: options.timestamped_get });
-    } else {
-        errorLog("timestamped_get has a invalid number of argument , should be 0 or 1  ");
-        throw new Error("timestamped_get has a invalid number of argument , should be 0 or 1  ");
-    }
-}
-
-// variation 1
-function _Variable_bind_with_simple_get(this: UAVariableImpl, options: GetterOptions) {
-    assert(this instanceof UAVariableImpl);
-    assert(typeof options.get === "function", "should specify get function");
-    assert(options.get?.length === 0, "get function should not have arguments");
-    assert(!options.timestamped_get, "should not specify a timestamped_get function when get is specified");
-    assert(!this._timestamped_get_func);
-    assert(!this._get_func);
-
-    this._get_func = options.get;
-
-    const timestamped_get_func_from__Variable_bind_with_simple_get = () => {
-        const value: Variant | StatusCode = (this._get_func as GetFunc)();
-
-        /* c8 ignore next */
-        if (!is_Variant_or_StatusCode(value)) {
-            errorLog(
-                chalk.red(" Bind variable error: "),
-                " : the getter must return a Variant or a StatusCode" + "\nvalue_check.constructor.name ",
-                value ? value.constructor.name : "null"
-            );
-            throw new Error(
-                " bindVariable : the value getter function returns a invalid result ( expecting a Variant or a StatusCode !!!"
-            );
-        }
-        if (is_StatusCode(value)) {
-            return new DataValue({ statusCode: value as StatusCode });
-        } else {
-            if (!this.$dataValue?.statusCode.isGoodish() || !sameVariant(this.$dataValue.value, value as Variant)) {
-                // rebuilding artificially timestamps with current clock as they are not provided
-                // by the underlying getter function
-                const { timestamp: sourceTimestamp, picoseconds: sourcePicoseconds } = getCurrentClock();
-                const serverTimestamp = sourceTimestamp;
-                const serverPicoseconds = sourcePicoseconds;
-                this._inner_replace_dataValue(
-                    new DataValue({ value, sourceTimestamp, sourcePicoseconds, serverTimestamp, serverPicoseconds })
-                );
-            }
-            return this.$dataValue;
-        }
-    };
-
-    _Variable_bind_with_timestamped_get.call(this, {
-        get: undefined,
-        timestamped_get: timestamped_get_func_from__Variable_bind_with_simple_get
-    });
-}
-
-type SimpleSetOptions = { set?: SetFunc; timestamped_set: undefined };
-function _Variable_bind_with_simple_set(this: UAVariableImpl, options: SimpleSetOptions) {
-    assert(this instanceof UAVariableImpl);
-    assert(typeof options.set === "function", "should specify set function");
-    assert(!options.timestamped_set, "should not specify a timestamped_set function");
-
-    assert(!this._timestamped_set_func);
-    assert(!this._set_func);
-
-    //
-    const set_func = turn_sync_to_async<UAVariable, Variant, StatusCode>(options.set as VariableSetter, 1);
-    this._set_func = set_func;
-
-    assert(set_func.length === 2, " set function must have 2 arguments ( variant, callback)");
-
-    this._timestamped_set_func = (
-        timestamped_value: DataValue,
-        callback: (err: Error | null, statusCode: StatusCode, dataValue: DataValue) => void
-    ) => {
-        assert(timestamped_value instanceof DataValue);
-        set_func.call(this, timestamped_value.value, (err: Error | null, statusCode?: StatusCode) => {
-            // c8 ignore next
-            if (!err && !statusCode) {
-                errorLog(
-                    chalk.red("UAVariable Binding Error _set_func must return a StatusCode, check the bindVariable parameters")
-                );
-                errorLog(chalk.yellow("StatusCode.Good is assumed"));
-                return callback(err, StatusCodes.Good, timestamped_value);
-            }
-            if (statusCode?.isNotGood()) {
-                // record the value but still record the statusCode !
-                timestamped_value.statusCode = statusCode;
-            }
-            callback(err, statusCode ?? StatusCodes.BadInternalError, timestamped_value);
-        });
-    };
-}
-
-function _Variable_bind_with_timestamped_set(
-    this: UAVariableImpl,
-    options: {
-        timestamped_set: TimestampSetFunc;
-        set: undefined;
-    }
-) {
-    assert(
-        options.timestamped_set.length === 2 || options.timestamped_set.length === 1,
-        "timestamped_set must have 2 parameters  timestamped_set: function(dataValue,callback){} or one paramater  timestamped_set: function(dataValue): Promise<StatusCode>{}"
-    );
-    assert(!options.set, "should not specify set when timestamped_set_func exists ");
-    this._timestamped_set_func = convertToCallbackFunction1<StatusCode, DataValue, UAVariable>(options.timestamped_set);
-}
-
-interface SetterOptions {
-    set?: SetFunc;
-    timestamped_set?: TimestampSetFunc;
-    timestamped_get?: TimestampGetFunc;
-}
-function bind_setter(this: UAVariableImpl, options: SetterOptions) {
-    if (options.set && typeof options.set === "function") {
-        // variation 1
-        if (options.timestamped_set === undefined) {
-            _Variable_bind_with_simple_set.call(this, options as SimpleSetOptions);
-        } else {
-            throw new Error("bind_setter : options should not specify both set and timestamped_set ");
-        }
-    } else if (typeof options.timestamped_set === "function") {
-        // variation 2
-        assert(typeof options.timestamped_get === "function", "timestamped_set must be used with timestamped_get ");
-        _Variable_bind_with_timestamped_set.call(this, {
-            set: undefined,
-            timestamped_set: options.timestamped_set
-        });
-    } else if (typeof options.timestamped_get === "function") {
-        // timestamped_get is  specified but timestamped_set is not
-        // => Value is read-only
-        _Variable_bind_with_timestamped_set.call(this, {
-            set: undefined,
-            timestamped_set: _not_writable_timestamped_set_func
-        });
-    } else {
-        _Variable_bind_with_timestamped_set.call(this, {
-            set: undefined,
-            timestamped_set: _default_writable_timestamped_set_func
-        });
-    }
-}
-
-type RefreshFunc = (callback: CallbackT<DataValue>) => void;
-interface GetterOptions {
-    get?: GetFunc;
-    timestamped_get?: TimestampGetFunc;
-    refreshFunc?: RefreshFunc;
-    dataType?: DataType | string;
-    value?: unknown;
-}
-function bind_getter(this: UAVariableImpl, options: GetterOptions) {
-    if (typeof options.get === "function") {
-        // variation 1
-        _Variable_bind_with_simple_get.call(this, options);
-    } else if (typeof options.timestamped_get === "function") {
-        // variation 2
-        _Variable_bind_with_timestamped_get.call(this, {
-            get: undefined,
-            timestamped_get: options.timestamped_get
-        });
-    } else if (typeof options.refreshFunc === "function") {
-        // variation 3
-        if (options.get !== undefined || options.timestamped_get !== undefined) {
-            throw new Error("bind_getter : options should not specify both get and timestamped_get ");
-        }
-        _Variable_bind_with_async_refresh.call(this, { refreshFunc: options.refreshFunc });
-    } else {
-        assert(!Object.hasOwn(options, "set"), "getter is missing : a getter must be provided if a setter is provided");
-        // xx bind_variant.call(this,options);
-        if (options.dataType !== undefined) {
-            // if (options.dataType !== DataType.ExtensionObject) {
-            this.setValueFromSource(options as VariantLike);
-            // }
-        }
-    }
-}
-
-export class UAVariableImplT<T, DT extends DataType> extends UAVariableImpl {
-    public readValue(
-        context?: ISessionContext | null,
-        indexRange?: NumericRange,
-        dataEncoding?: QualifiedNameLike | null
-    ): DataValueT<T, DT> {
-        return super.readValue(context, indexRange, dataEncoding) as DataValueT<T, DT>;
-    }
-
-    public readValueAsync(context: ISessionContext | null): Promise<DataValueT<T, DT>>;
-    public readValueAsync(context: ISessionContext | null, callback: CallbackT<DataValueT<T, DT>>): void;
-    public readValueAsync(
-        context: ISessionContext | null,
-        callback?: CallbackT<DataValueT<T, DT>>
-    ): Promise<DataValueT<T, DT>> | undefined {
-        return super.readValueAsync(context, callback as CallbackT<DataValue>) as Promise<DataValueT<T, DT>> | undefined;
-    }
-
-    public writeValue(
-        context: ISessionContext,
-        dataValue: DataValueT<T, DT>,
-        indexRange: NumericRange | null,
-        callback: StatusCodeCallback
-    ): void;
-    public writeValue(context: ISessionContext, dataValue: DataValueT<T, DT>, callback: StatusCodeCallback): void;
-    public writeValue(
-        context: ISessionContext,
-        dataValue: DataValueT<T, DT>,
-        indexRange?: NumericRange | null
-    ): Promise<StatusCode>;
-    public writeValue(
-        context: ISessionContext,
-        dataValue: DataValueT<T, DT>,
-        indexRangeOrCallback?: NumericRange | null | StatusCodeCallback,
-        callback?: StatusCodeCallback
-    ): Promise<StatusCode> | undefined {
-        return (super.writeValue as (...args: unknown[]) => Promise<StatusCode> | undefined)(
-            context,
-            dataValue,
-            indexRangeOrCallback,
-            callback
-        );
-    }
-}
-
-function changeUAVariableDataType(uaVariable: UAVariableImpl, newDataType: NodeIdLike, valueLike?: VariantLike) {
-    let value: Variant | null = valueLike ? (valueLike instanceof Variant ? valueLike : new Variant(valueLike)) : null;
-
-    const addressSpace = uaVariable.addressSpace;
-    const newDataTypeNode = addressSpace.findNode(newDataType) as UADataType;
-    // c8 ignore next
-    if (!newDataTypeNode || !(newDataTypeNode instanceof UADataTypeImpl)) {
-        throw new Error(`Cannot find newDataTypeNode ${newDataType.toString()}`);
-    }
-
-    const newBaseDataType: DataType = newDataTypeNode.basicDataType;
-    // c8 ignore next
-    if (newBaseDataType === DataType.Null) {
-        throw new Error("newDataTypeNode must be a DataType");
-    }
-    if (!value) {
-        value = uaVariable.readValue().value;
-        value.dataType = newBaseDataType;
-    }
-    if (newBaseDataType !== value.dataType) {
-        throw new Error("newDataTypeNode must be of the same base dataType as the value");
-    }
-
-    // change uaVariable.dataType
-    uaVariable.dataType = newDataTypeNode.nodeId;
-    (uaVariable as unknown as { _basicDataType?: DataType | null })._basicDataType = null;
-    uaVariable.$dataValue.value.dataType = newBaseDataType;
-    uaVariable.$dataValue.value = value;
-    // also change the value to ensure that we have a default value with the correct dataType
-    uaVariable._internal_set_value(value);
-}