node-opcua-address-space 2.51.0

package/dist/src/ua_reference_type_impl.js

@@ -0,0 +1,138 @@
+"use strict";
+/**
+ * @module node-opcua-address-space
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UAReferenceTypeImpl = void 0;
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_data_model_1 = require("node-opcua-data-model");
+const node_opcua_data_model_2 = require("node-opcua-data-model");
+const node_opcua_data_model_3 = require("node-opcua-data-model");
+const node_opcua_data_value_1 = require("node-opcua-data-value");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+const node_opcua_variant_1 = require("node-opcua-variant");
+const source_1 = require("../source");
+const base_node_impl_1 = require("./base_node_impl");
+const tools = require("./tool_isSupertypeOf");
+const tool_isSupertypeOf_1 = require("./tool_isSupertypeOf");
+const reference_impl_1 = require("./reference_impl");
+const base_node_private_1 = require("./base_node_private");
+const ReferenceTypeCounter = { count: 0 };
+function _internal_getAllSubtypes(referenceType) {
+    const addressSpace = referenceType.addressSpace;
+    const possibleReferenceTypes = [];
+    const hasSubtypeReferenceType = addressSpace.findReferenceType("HasSubtype");
+    function _findAllSubType(referenceTypeInner) {
+        possibleReferenceTypes.push(referenceTypeInner);
+        (0, node_opcua_assert_1.assert)(referenceTypeInner.nodeClass === node_opcua_data_model_2.NodeClass.ReferenceType);
+        const references = referenceTypeInner.findReferences(hasSubtypeReferenceType, true);
+        for (const _r of references) {
+            const subType = addressSpace.findReferenceType(_r.nodeId);
+            _findAllSubType(subType);
+        }
+    }
+    _findAllSubType(referenceType);
+    return possibleReferenceTypes;
+}
+function _getAllSubtypes(ref) {
+    const _cache = (0, base_node_private_1.BaseNode_getCache)(ref);
+    if (!_cache._allSubTypesVersion || _cache._allSubTypesVersion < ReferenceTypeCounter.count) {
+        _cache._allSubTypes = null;
+    }
+    if (!_cache._allSubTypes) {
+        _cache._allSubTypes = _internal_getAllSubtypes(ref);
+        _cache._allSubTypesVersion = ReferenceTypeCounter.count;
+    }
+    return _cache._allSubTypes;
+}
+function _internal_getSubtypeIndex(referenceType) {
+    const possibleReferenceTypes = _getAllSubtypes(referenceType);
+    // create a index of reference type with browseName as key for faster search
+    const keys = {};
+    for (const refType of possibleReferenceTypes) {
+        keys[refType.nodeId.toString()] = refType;
+    }
+    return keys;
+}
+function _getSubtypeIndex(referenceType) {
+    const _cache = (0, base_node_private_1.BaseNode_getCache)(referenceType);
+    if (!_cache._subtype_idx || _cache._subtype_idxVersion < ReferenceTypeCounter.count) {
+        // the cache need to be invalidated
+        _cache._subtype_idx = null;
+    }
+    if (!_cache._subtype_idx) {
+        _cache._subtype_idx = _internal_getSubtypeIndex(referenceType);
+        _cache._subtype_idxVersion = ReferenceTypeCounter.count;
+    }
+    return _cache._subtype_idx;
+}
+class UAReferenceTypeImpl extends base_node_impl_1.BaseNodeImpl {
+    constructor(options) {
+        super(options);
+        this.nodeClass = node_opcua_data_model_2.NodeClass.ReferenceType;
+        /**
+         * returns true if self is  a super type of baseType
+         */
+        this.isSupertypeOf = tools.construct_isSupertypeOf(UAReferenceTypeImpl);
+        /**
+         * @private
+         */
+        this._slow_isSupertypeOf = tools.construct_slow_isSupertypeOf(UAReferenceTypeImpl);
+        this.isAbstract = options.isAbstract === undefined ? false : !!options.isAbstract;
+        this.symmetric = options.symmetric === undefined ? false : !!options.symmetric;
+        // Note: Inverse name is not required anymore in 1.0.4
+        this.inverseName = (0, node_opcua_data_model_1.coerceLocalizedText)(options.inverseName || this.browseName.name);
+        ReferenceTypeCounter.count += 1;
+    }
+    get subtypeOfObj() {
+        return tool_isSupertypeOf_1.get_subtypeOfObj.call(this);
+    }
+    get subtypeOf() {
+        return tool_isSupertypeOf_1.get_subtypeOf.call(this);
+    }
+    readAttribute(context, attributeId) {
+        (0, node_opcua_assert_1.assert)(!context || context instanceof source_1.SessionContext);
+        const options = {};
+        switch (attributeId) {
+            case node_opcua_data_model_3.AttributeIds.IsAbstract:
+                options.value = { dataType: node_opcua_variant_1.DataType.Boolean, value: !!this.isAbstract };
+                options.statusCode = node_opcua_status_code_1.StatusCodes.Good;
+                break;
+            case node_opcua_data_model_3.AttributeIds.Symmetric:
+                options.value = { dataType: node_opcua_variant_1.DataType.Boolean, value: !!this.symmetric };
+                options.statusCode = node_opcua_status_code_1.StatusCodes.Good;
+                break;
+            case node_opcua_data_model_3.AttributeIds.InverseName: // LocalizedText
+                options.value = { dataType: node_opcua_variant_1.DataType.LocalizedText, value: this.inverseName };
+                options.statusCode = node_opcua_status_code_1.StatusCodes.Good;
+                break;
+            default:
+                return super.readAttribute(context, attributeId);
+        }
+        return new node_opcua_data_value_1.DataValue(options);
+    }
+    toString() {
+        let str = "";
+        str += this.isAbstract ? "A" : " ";
+        str += this.symmetric ? "S" : " ";
+        str += " " + this.browseName.toString() + "/" + this.inverseName.text + " ";
+        str += this.nodeId.toString();
+        return str;
+    }
+    install_extra_properties() { }
+    /**
+     * returns a array of all ReferenceTypes in the addressSpace that are self or a subType of self
+     * recursively
+     */
+    getAllSubtypes() {
+        return _getAllSubtypes(this);
+    }
+    checkHasSubtype(ref) {
+        const _index = _getSubtypeIndex(this);
+        const referenceTypeNodeId = ref instanceof reference_impl_1.ReferenceImpl ? ref.nodeId : ref;
+        const _key = referenceTypeNodeId.toString();
+        return !!_index[_key];
+    }
+}
+exports.UAReferenceTypeImpl = UAReferenceTypeImpl;
+//# sourceMappingURL=ua_reference_type_impl.js.map

package/dist/src/ua_reference_type_impl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ua_reference_type_impl.js","sourceRoot":"","sources":["../../src/ua_reference_type_impl.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAGH,yDAA2C;AAC3C,iEAAkF;AAClF,iEAAiE;AACjE,iEAAqD;AACrD,iEAAiE;AAEjE,mEAAqD;AACrD,2DAA8C;AAE9C,sCAAqF;AACrF,qDAAyE;AACzE,8CAA8C;AAC9C,6DAAuE;AACvE,qDAAiD;AACjD,2DAE6B;AAG7B,MAAM,oBAAoB,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;AAG1C,SAAS,wBAAwB,CAAC,aAA8B;IAC5D,MAAM,YAAY,GAAG,aAAa,CAAC,YAAY,CAAC;IAChD,MAAM,sBAAsB,GAAsB,EAAE,CAAC;IAErD,MAAM,uBAAuB,GAAG,YAAY,CAAC,iBAAiB,CAAC,YAAY,CAAE,CAAC;IAE9E,SAAS,eAAe,CAAC,kBAAmC;QACxD,sBAAsB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAChD,IAAA,0BAAM,EAAC,kBAAkB,CAAC,SAAS,KAAK,iCAAS,CAAC,aAAa,CAAC,CAAC;QACjE,MAAM,UAAU,GAAG,kBAAkB,CAAC,cAAc,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAC;QACpF,KAAK,MAAM,EAAE,IAAI,UAAU,EAAE;YACzB,MAAM,OAAO,GAA0B,YAAY,CAAC,iBAAiB,CAAC,EAAE,CAAC,MAAM,CAAE,CAAC;YAClF,eAAe,CAAC,OAAO,CAAC,CAAC;SAC5B;IACL,CAAC;IACD,eAAe,CAAC,aAAa,CAAC,CAAC;IAC/B,OAAO,sBAAsB,CAAC;AAClC,CAAC;AAED,SAAS,eAAe,CAAC,GAAoB;IAEzC,MAAM,MAAM,GAAG,IAAA,qCAAiB,EAAC,GAAG,CAAC,CAAC;IAEtC,IAAI,CAAC,MAAM,CAAC,mBAAmB,IAAI,MAAM,CAAC,mBAAmB,GAAG,oBAAoB,CAAC,KAAK,EAAE;QACxF,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC;KAC9B;IACD,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;QACtB,MAAM,CAAC,YAAY,GAAG,wBAAwB,CAAC,GAAG,CAAC,CAAC;QACpD,MAAM,CAAC,mBAAmB,GAAG,oBAAoB,CAAC,KAAK,CAAC;KAC3D;IACD,OAAO,MAAM,CAAC,YAAY,CAAC;AAC/B,CAAC;AAED,SAAS,yBAAyB,CAAC,aAA8B;IAC7D,MAAM,sBAAsB,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC;IAC9D,4EAA4E;IAC5E,MAAM,IAAI,GAAQ,EAAE,CAAC;IACrB,KAAK,MAAM,OAAO,IAAI,sBAAsB,EAAE;QAC1C,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC;KAC7C;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAS,gBAAgB,CAAC,aAA8B;IAEpD,MAAM,MAAM,GAAG,IAAA,qCAAiB,EAAC,aAAa,CAAC,CAAC;IAChD,IAAI,CAAC,MAAM,CAAC,YAAY,IAAK,MAAM,CAAC,mBAAmB,GAAG,oBAAoB,CAAC,KAAK,EAAE;QAClF,mCAAmC;QACnC,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC;KAC9B;IACD,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;QACtB,MAAM,CAAC,YAAY,GAAG,yBAAyB,CAAC,aAAa,CAAC,CAAC;QAC/D,MAAM,CAAC,mBAAmB,GAAG,oBAAoB,CAAC,KAAK,CAAC;KAC3D;IACD,OAAO,MAAM,CAAC,YAAY,CAAC;AAC/B,CAAC;AAQD,MAAa,mBAAoB,SAAQ,6BAAY;IAwBjD,YAAY,OAA+B;QACvC,KAAK,CAAC,OAAO,CAAC,CAAC;QAxBH,cAAS,GAAG,iCAAS,CAAC,aAAa,CAAC;QAapD;;WAEG;QACI,kBAAa,GAAG,KAAK,CAAC,uBAAuB,CAAkB,mBAAmB,CAAC,CAAC;QAE3F;;WAEG;QACI,wBAAmB,GAAG,KAAK,CAAC,4BAA4B,CAAkB,mBAAmB,CAAC,CAAC;QAIlG,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;QAClF,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;QAC/E,sDAAsD;QACtD,IAAI,CAAC,WAAW,GAAG,IAAA,2CAAmB,EAAC,OAAO,CAAC,WAAW,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAE,CAAC;QAErF,oBAAoB,CAAC,KAAK,IAAI,CAAC,CAAC;IACpC,CAAC;IA1BD,IAAW,YAAY;QACnB,OAAO,qCAAgB,CAAC,IAAI,CAAC,IAAI,CAAoB,CAAC;IAC1D,CAAC;IAED,IAAW,SAAS;QAChB,OAAO,kCAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAsBM,aAAa,CAAC,OAA8B,EAAE,WAAyB;QAC1E,IAAA,0BAAM,EAAC,CAAC,OAAO,IAAI,OAAO,YAAY,uBAAc,CAAC,CAAC;QAEtD,MAAM,OAAO,GAAkB,EAAE,CAAC;QAClC,QAAQ,WAAW,EAAE;YACjB,KAAK,oCAAY,CAAC,UAAU;gBACxB,OAAO,CAAC,KAAK,GAAG,EAAE,QAAQ,EAAE,6BAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;gBACzE,OAAO,CAAC,UAAU,GAAG,oCAAW,CAAC,IAAI,CAAC;gBACtC,MAAM;YACV,KAAK,oCAAY,CAAC,SAAS;gBACvB,OAAO,CAAC,KAAK,GAAG,EAAE,QAAQ,EAAE,6BAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;gBACxE,OAAO,CAAC,UAAU,GAAG,oCAAW,CAAC,IAAI,CAAC;gBACtC,MAAM;YACV,KAAK,oCAAY,CAAC,WAAW,EAAE,gBAAgB;gBAC3C,OAAO,CAAC,KAAK,GAAG,EAAE,QAAQ,EAAE,6BAAQ,CAAC,aAAa,EAAE,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;gBAC9E,OAAO,CAAC,UAAU,GAAG,oCAAW,CAAC,IAAI,CAAC;gBACtC,MAAM;YACV;gBACI,OAAO,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;SACxD;QACD,OAAO,IAAI,iCAAS,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAEM,QAAQ;QACX,IAAI,GAAG,GAAG,EAAE,CAAC;QACb,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QACnC,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QAClC,GAAG,IAAI,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG,GAAG,CAAC;QAC5E,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC9B,OAAO,GAAG,CAAC;IACf,CAAC;IAEM,wBAAwB,KAAmB,CAAC;IAEnD;;;OAGG;IACI,cAAc;QACjB,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAEM,eAAe,CAAC,GAAyB;QAC5C,MAAM,MAAM,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,mBAAmB,GAAG,GAAG,YAAY,8BAAa,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAa,CAAC;QACtF,MAAM,IAAI,GAAG,mBAAmB,CAAC,QAAQ,EAAE,CAAC;QAC5C,OAAO,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;CAEJ;AAnFD,kDAmFC"}

package/dist/src/ua_variable.d.ts

@@ -0,0 +1,346 @@
+import { QualifiedNameLike, NodeClass, AccessLevelFlag, AttributeIds } from "node-opcua-data-model";
+import { DataValue, DataValueOptions } from "node-opcua-data-value";
+import { PreciseClock } from "node-opcua-date-time";
+import { ExtensionObject } from "node-opcua-extension-object";
+import { NodeId } from "node-opcua-nodeid";
+import { NumericRange } from "node-opcua-numeric-range";
+import { WriteValue, WriteValueOptions } from "node-opcua-service-write";
+import { StatusCode, CallbackT } from "node-opcua-status-code";
+import { HistoryReadResult, ReadAtTimeDetails, ReadEventDetails, ReadProcessedDetails, ReadRawModifiedDetails } from "node-opcua-types";
+import { Variant, VariantLike, DataType } from "node-opcua-variant";
+import { StatusCodeCallback } from "node-opcua-status-code";
+import { BindVariableOptions, ContinuationPoint, DataValueCallback, HistoricalDataConfiguration, IVariableHistorian, UAVariable as UAVariablePublic, UAVariableType } from "../source";
+import { BaseNode, InternalBaseNodeOptions } from "./base_node";
+import { CloneOptions, CloneFilter, CloneExtraInfo } from "./base_node_private";
+import { SessionContext } from "./session_context";
+import { EnumerationInfo, IEnumItem, UADataType } from "./ua_data_type";
+export declare function adjust_accessLevel(accessLevel: string | number | null): AccessLevelFlag;
+export declare function adjust_userAccessLevel(userAccessLevel: string | number | null | undefined, accessLevel: string | number | null): AccessLevelFlag | undefined;
+interface UAVariableOptions extends InternalBaseNodeOptions {
+    value?: any;
+    dataType: NodeId | string;
+    valueRank?: number;
+    arrayDimensions?: null | number[];
+    accessLevel?: any;
+    userAccessLevel?: any;
+    minimumSamplingInterval?: number;
+    historizing?: number;
+}
+export declare function verifyRankAndDimensions(options: {
+    valueRank?: number;
+    arrayDimensions?: number[] | null;
+}): void;
+declare type TimestampGetFunction1 = () => DataValue | Promise<DataValue>;
+declare type TimestampGetFunction2 = (callback: (err: Error | null, dataValue?: DataValue) => void) => void;
+declare type TimestampGetFunction = TimestampGetFunction1 | TimestampGetFunction2;
+declare type TimestampSetFunction1 = (this: UAVariable, dataValue: DataValue, indexRange: NumericRange) => void | Promise<void>;
+declare type TimestampSetFunction2 = (this: UAVariable, dataValue: DataValue, indexRange: NumericRange, callback: (err: Error | null, StatusCode: StatusCode) => void) => void;
+declare type TimestampSetFunction = TimestampSetFunction1 | TimestampSetFunction2;
+/**
+ * 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 declare class UAVariable extends BaseNode implements UAVariablePublic {
+    readonly nodeClass = NodeClass.Variable;
+    dataType: NodeId;
+    $historicalDataConfiguration?: HistoricalDataConfiguration;
+    varHistorian?: IVariableHistorian;
+    /**
+     * @internal
+     */
+    _dataValue: DataValue;
+    accessLevel: number;
+    userAccessLevel?: number;
+    valueRank: number;
+    minimumSamplingInterval: number;
+    historizing: boolean;
+    semantic_version: number;
+    arrayDimensions: null | number[];
+    $extensionObject?: any;
+    _timestamped_get_func?: TimestampGetFunction | null;
+    _timestamped_set_func?: TimestampSetFunction | null;
+    _get_func: any;
+    _set_func: any;
+    refreshFunc?: (callback: DataValueCallback) => void;
+    __waiting_callbacks?: any[];
+    get typeDefinitionObj(): UAVariableType;
+    constructor(options: UAVariableOptions);
+    private checkPermissionAndAccessLevelPrivate;
+    isReadable(context: SessionContext): boolean;
+    isUserReadable(context: SessionContext): boolean;
+    isWritable(context: SessionContext): boolean;
+    isUserWritable(context: SessionContext): boolean;
+    /**
+     *
+     *
+     * 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)
+     */
+    readValue(context?: SessionContext | null, indexRange?: NumericRange, dataEncoding?: string): DataValue;
+    isEnumeration(): boolean;
+    isExtensionObject(): boolean;
+    _getEnumerationInfo(): EnumerationInfo;
+    asyncRefresh(...args: any[]): any;
+    readEnumValue(): IEnumItem;
+    writeEnumValue(value: string | number): void;
+    readAttribute(context: SessionContext | null, attributeId: AttributeIds, indexRange?: NumericRange, dataEncoding?: string): DataValue;
+    adjustVariant(variant: Variant): Variant;
+    /**
+     * setValueFromSource is used to let the device sets the variable values
+     * this method also records the current time as sourceTimestamp and serverTimestamp.
+     * the method broadcasts an "value_changed" event
+     *
+     * The method will raise an exception if the value is not compatible with the dataType and expected dimension
+     *
+     * @method setValueFromSource
+     * @param variant  {Variant}
+     * @param [statusCode  {StatusCode} = StatusCodes.Good]
+     * @param [sourceTimestamp= Now]
+     */
+    setValueFromSource(variant: VariantLike, statusCode?: StatusCode, sourceTimestamp?: Date): void;
+    writeValue(context: SessionContext, dataValue: DataValueOptions, indexRange: string | NumericRange | null, callback: StatusCodeCallback): void;
+    writeValue(context: SessionContext, dataValue: DataValueOptions, callback: StatusCodeCallback): void;
+    writeValue(context: SessionContext, dataValue: DataValueOptions, indexRange?: string | NumericRange | null): Promise<StatusCode>;
+    writeAttribute(context: SessionContext | null, writeValueOptions: WriteValueOptions | WriteValue, callback?: (err: Error | null, statusCode?: StatusCode) => void): any;
+    /**
+     * @method checkVariantCompatibility
+     * note:
+     *     this method is overridden in address-space-data-access
+     * @return {StatusCode}
+     */
+    checkVariantCompatibility(value: Variant): StatusCode;
+    /**
+     * @method touchValue
+     * touch the source timestamp of a Variable and cascade up the change
+     * to the parent variable if any.
+     *
+     * @param [optionalNow=null] {Object}
+     * @param optionalNow.timestamp    {Date}
+     * @param optionalNow.picoseconds  {Number}
+     */
+    touchValue(optionalNow?: PreciseClock): void;
+    /**
+     * bind a variable with a get and set functions.
+     *
+     * @method bindVariable
+     * @param options
+     * @param [options.dataType=null]    the nodeId of the dataType
+     * @param [options.accessLevel]      AccessLevelFlagItem
+     * @param [options.userAccessLevel]  AccessLevelFlagItem
+     * @param [options.set]              the variable setter function
+     * @param [options.get]              the variable getter function. the function must return a Variant or a status code
+     * @param [options.timestamped_get]  the getter function. this function must return a object with the following
+     * @param [options.historyRead]
+     *
+     *  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;
+     *
+     */
+    bindVariable(options?: BindVariableOptions, overwrite?: boolean): void;
+    /**
+     * @method readValueAsync
+     */
+    readValueAsync(context: SessionContext | null, callback: CallbackT<DataValue>): void;
+    readValueAsync(context: SessionContext | null): Promise<DataValue>;
+    getWriteMask(): number;
+    getUserWriteMask(): number;
+    clone(options: CloneOptions, optionalFilter?: CloneFilter, extraInfo?: CloneExtraInfo): UAVariable;
+    getDataTypeNode(): UADataType;
+    get dataTypeObj(): UADataType;
+    checkExtensionObjectIsCorrect(extObj: ExtensionObject | ExtensionObject[] | null): boolean;
+    /**
+     * @method bindExtensionObject
+     * @return {ExtensionObject}
+     */
+    bindExtensionObject(optionalExtensionObject?: ExtensionObject): ExtensionObject | null;
+    updateExtensionObjectPartial(partialExtensionObject: any): any;
+    incrementExtensionObjectPartial(path: any): void;
+    constructExtensionObjectFromComponents(): any;
+    toString(): string;
+    historyRead(context: SessionContext, historyReadDetails: ReadRawModifiedDetails | ReadEventDetails | ReadProcessedDetails | ReadAtTimeDetails, indexRange: NumericRange | null, dataEncoding: QualifiedNameLike | null, continuationPoint?: ContinuationPoint | null, callback?: CallbackT<HistoryReadResult>): any;
+    _historyReadRaw(context: SessionContext, historyReadRawModifiedDetails: ReadRawModifiedDetails, indexRange: NumericRange | null, dataEncoding: QualifiedNameLike | null, continuationPoint: ContinuationPoint | null, callback: CallbackT<HistoryReadResult>): void;
+    _historyReadRawModify(context: SessionContext, historyReadRawModifiedDetails: ReadRawModifiedDetails, indexRange: NumericRange | null, dataEncoding: QualifiedNameLike | null, continuationPoint?: ContinuationPoint | null, callback?: CallbackT<HistoryReadResult>): any;
+    _historyRead(context: SessionContext, historyReadDetails: ReadRawModifiedDetails | ReadEventDetails | ReadProcessedDetails | ReadAtTimeDetails, indexRange: NumericRange | null, dataEncoding: QualifiedNameLike | null, continuationPoint: ContinuationPoint | null, callback: CallbackT<HistoryReadResult>): void;
+    _historyPush(newDataValue: DataValue): any;
+    _historyReadRawAsync(historyReadRawModifiedDetails: ReadRawModifiedDetails, maxNumberToExtract: number, isReversed: boolean, reverseDataValue: boolean, callback: CallbackT<DataValue[]>): any;
+    _historyReadModify(context: SessionContext, historyReadRawModifiedDetails: any, indexRange: NumericRange | null, dataEncoding: QualifiedNameLike | null, continuationPoint: ContinuationPoint | null, callback: CallbackT<HistoryReadResult>): any;
+    _update_startOfOnlineArchive(newDate: Date): void;
+    _update_startOfArchive(newDate: Date): void;
+    _validate_DataType(variantDataType: DataType): boolean;
+    _internal_set_dataValue(dataValue: DataValue, indexRange?: NumericRange | null): void;
+    _conditionRefresh(_cache?: any): void;
+    handle_semantic_changed(): void;
+    private _readDataType;
+    private _readValueRank;
+    private _readArrayDimensions;
+    private _readAccessLevel;
+    private _readAccessLevelEx;
+    private _readUserAccessLevel;
+    private _readMinimumSamplingInterval;
+    private _readHistorizing;
+}
+export interface UAVariable {
+    $$variableType?: any;
+    $$dataType?: any;
+    $$getElementBrowseName: any;
+    $$extensionObjectArray: any;
+    $$indexPropertyName: any;
+}
+export {};