node-opcua-address-space 2.76.0 → 2.77.0

package/dist/src/alarms_and_conditions/ua_off_normal_alarm_impl.js

@@ -1,167 +1,167 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UAOffNormalAlarmImpl = void 0;
-const node_opcua_assert_1 = require("node-opcua-assert");
-const node_opcua_nodeid_1 = require("node-opcua-nodeid");
-const node_opcua_status_code_1 = require("node-opcua-status-code");
-const utils = require("node-opcua-utils");
-const node_opcua_variant_1 = require("node-opcua-variant");
-const ua_discrete_alarm_impl_1 = require("./ua_discrete_alarm_impl");
-function isEqual(value1, value2) {
-    return value1 === value2;
-}
-/**
- * The OffNormalAlarmType is a specialization of the DiscreteAlarmType intended to represent a
- * discrete Condition that is considered to be not normal.
- * This sub type is usually used to indicate that a discrete value is in an Alarm state, it is active as
- * long as a non-normal value is present.
- */
-class UAOffNormalAlarmImpl extends ua_discrete_alarm_impl_1.UADiscreteAlarmImpl {
-    /**
-     * When the value of inputNode doesn't match the normalState node value, then the alarm is raised.
-     *
-     */
-    static instantiate(namespace, limitAlarmTypeId, options, data) {
-        const addressSpace = namespace.addressSpace;
-        const offNormalAlarmType = addressSpace.findEventType("OffNormalAlarmType");
-        /* istanbul ignore next */
-        if (!offNormalAlarmType) {
-            throw new Error("cannot find offNormalAlarmType");
-        }
-        (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(options, "inputNode"), "must provide inputNode"); // must provide a inputNode
-        (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(options, "normalState"), "must provide a normalState Node"); // must provide a inputNode
-        options.optionals = options.optionals || [];
-        (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(options, "inputNode"), "must provide inputNode"); // must provide a inputNode
-        const alarmNode = ua_discrete_alarm_impl_1.UADiscreteAlarmImpl.instantiate(namespace, limitAlarmTypeId, options, data);
-        Object.setPrototypeOf(alarmNode, UAOffNormalAlarmImpl.prototype);
-        /**
-         * The InputNode Property provides the NodeId of the Variable the Value of which is used as primary input in
-         * the calculation of the Alarm state.
-         *
-         * If this Variable is not in the AddressSpace, a NULL NodeId shall be provided.
-         *
-         * In some systems, an Alarm may be calculated based on multiple Variables Values;
-         * it is up to the system to determine which Variable’s NodeId is used.
-         */
-        const inputNode = addressSpace._coerceNode(options.inputNode);
-        // note: alarmNode.inputNode.readValue() already set by DiscreteAlarmImpl.instantiate
-        if (inputNode) {
-            // install inputNode Node monitoring for change
-            alarmNode.installInputNodeMonitoring(options.inputNode);
-        }
-        /**
-         * The NormalState Property is a Property that points to a Variable which has a value that corresponds to one
-         * of the possible values of the Variable pointed to by the InputNode Property where the NormalState Property
-         * Variable value is the value that is considered to be the normal state of the Variable pointed to by the InputNode
-         * Property. When the value of the Variable referenced by the InputNode Property is not equal to the value of the
-         * NormalState Property the Alarm is Active.
-         *
-         * If this Variable is not in the AddressSpace, a NULL NodeId shall be provided.
-         *
-         */
-        if (options.normalState) {
-            const normalState = addressSpace._coerceNode(options.normalState);
-            const normalStateNodeId = normalState ? normalState.nodeId : new node_opcua_nodeid_1.NodeId();
-            alarmNode.normalState.setValueFromSource({ dataType: node_opcua_variant_1.DataType.NodeId, value: normalStateNodeId });
-            alarmNode.normalState.on("value_changed", (newDataValue /*, oldDataValue: DataValue*/) => {
-                // The node that contains the normalState value has changed.
-                //   we must remove the listener on current normalState and replace
-                //   normalState with the new one and set listener again
-                //   to do:
-            });
-            if (normalState) {
-                // install normalState monitoring for change
-                normalState.on("value_changed", (newDataValue /*, oldDataValue: DataValue*/) => {
-                    alarmNode._onNormalStateDataValueChange(newDataValue);
-                });
-            }
-        }
-        else {
-            alarmNode.normalState.setValueFromSource({ dataType: node_opcua_variant_1.DataType.NodeId, value: node_opcua_nodeid_1.NodeId.nullNodeId });
-        }
-        alarmNode._mayBe_updateAlarmState();
-        return alarmNode;
-    }
-    // HasProperty Variable NormalState NodeId PropertyType Mandatory
-    // The NormalState Property is a Property that points to a Variable which has a value that
-    // corresponds to one of the possible values of the Variable pointed to by the InputNode
-    // Property where the NormalState Property Variable value is the value that is considered to be
-    // the normal state of the Variable pointed to by the InputNode Property. When the value of the
-    // Variable referenced by the InputNode Property is not equal to the value of the NormalState
-    // Property the Alarm is Active. If this Variable is not in the AddressSpace, a Null NodeId shall
-    // be provided.
-    getNormalStateNode() {
-        const nodeId = this.normalState.readValue().value.value;
-        const node = this.addressSpace.findNode(nodeId);
-        if (!node) {
-            return null;
-        }
-        return node;
-    }
-    /**
-     * @method getNormalStateValue
-     */
-    getNormalStateValue() {
-        const normalStateNode = this.getNormalStateNode();
-        if (!normalStateNode) {
-            return null;
-        }
-        return normalStateNode.readValue().value.value;
-    }
-    /**
-     * @method setNormalStateValue
-     * @param value
-     */
-    setNormalStateValue(value) {
-        const normalStateNode = this.getNormalStateNode();
-        throw new Error("Not Implemented yet");
-    }
-    updateAlarmState(isActive, message) {
-        if (isActive === this.activeState.getValue()) {
-            // no change => ignore !
-            return;
-        }
-        const stateName = isActive ? "Active" : "Inactive";
-        // also raise the event
-        this._signalNewCondition(stateName, isActive, message);
-        if (!isActive) {
-            this.currentBranch().setRetain(false);
-        }
-    }
-    _mayBe_updateAlarmState(normalStateValue, inputValue) {
-        if (utils.isNullOrUndefined(normalStateValue) || utils.isNullOrUndefined(inputValue)) {
-            this.activeState.setValue(false);
-            return;
-        }
-        const isActive = !isEqual(normalStateValue, inputValue);
-        this.updateAlarmState(isActive, "automatique update");
-    }
-    _onInputDataValueChange(dataValue) {
-        if (dataValue.statusCode !== node_opcua_status_code_1.StatusCodes.Good) {
-            // what shall we do ?
-            return;
-        }
-        if (dataValue.value.dataType === node_opcua_variant_1.DataType.Null) {
-            // what shall we do ?
-            return;
-        }
-        const inputValue = dataValue.value.value;
-        const normalStateValue = this.getNormalStateValue();
-        this._mayBe_updateAlarmState(normalStateValue, inputValue);
-    }
-    _onNormalStateDataValueChange(dataValue) {
-        if (dataValue.statusCode !== node_opcua_status_code_1.StatusCodes.Good) {
-            // what shall we do ?
-            return;
-        }
-        if (dataValue.value.dataType === node_opcua_variant_1.DataType.Null) {
-            // what shall we do ?
-            return;
-        }
-        const normalStateValue = dataValue.value.value;
-        const inputValue = this.getInputNodeValue();
-        this._mayBe_updateAlarmState(normalStateValue, inputValue);
-    }
-}
-exports.UAOffNormalAlarmImpl = UAOffNormalAlarmImpl;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UAOffNormalAlarmImpl = void 0;
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_nodeid_1 = require("node-opcua-nodeid");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+const utils = require("node-opcua-utils");
+const node_opcua_variant_1 = require("node-opcua-variant");
+const ua_discrete_alarm_impl_1 = require("./ua_discrete_alarm_impl");
+function isEqual(value1, value2) {
+    return value1 === value2;
+}
+/**
+ * The OffNormalAlarmType is a specialization of the DiscreteAlarmType intended to represent a
+ * discrete Condition that is considered to be not normal.
+ * This sub type is usually used to indicate that a discrete value is in an Alarm state, it is active as
+ * long as a non-normal value is present.
+ */
+class UAOffNormalAlarmImpl extends ua_discrete_alarm_impl_1.UADiscreteAlarmImpl {
+    /**
+     * When the value of inputNode doesn't match the normalState node value, then the alarm is raised.
+     *
+     */
+    static instantiate(namespace, limitAlarmTypeId, options, data) {
+        const addressSpace = namespace.addressSpace;
+        const offNormalAlarmType = addressSpace.findEventType("OffNormalAlarmType");
+        /* istanbul ignore next */
+        if (!offNormalAlarmType) {
+            throw new Error("cannot find offNormalAlarmType");
+        }
+        (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(options, "inputNode"), "must provide inputNode"); // must provide a inputNode
+        (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(options, "normalState"), "must provide a normalState Node"); // must provide a inputNode
+        options.optionals = options.optionals || [];
+        (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(options, "inputNode"), "must provide inputNode"); // must provide a inputNode
+        const alarmNode = ua_discrete_alarm_impl_1.UADiscreteAlarmImpl.instantiate(namespace, limitAlarmTypeId, options, data);
+        Object.setPrototypeOf(alarmNode, UAOffNormalAlarmImpl.prototype);
+        /**
+         * The InputNode Property provides the NodeId of the Variable the Value of which is used as primary input in
+         * the calculation of the Alarm state.
+         *
+         * If this Variable is not in the AddressSpace, a NULL NodeId shall be provided.
+         *
+         * In some systems, an Alarm may be calculated based on multiple Variables Values;
+         * it is up to the system to determine which Variable’s NodeId is used.
+         */
+        const inputNode = addressSpace._coerceNode(options.inputNode);
+        // note: alarmNode.inputNode.readValue() already set by DiscreteAlarmImpl.instantiate
+        if (inputNode) {
+            // install inputNode Node monitoring for change
+            alarmNode.installInputNodeMonitoring(options.inputNode);
+        }
+        /**
+         * The NormalState Property is a Property that points to a Variable which has a value that corresponds to one
+         * of the possible values of the Variable pointed to by the InputNode Property where the NormalState Property
+         * Variable value is the value that is considered to be the normal state of the Variable pointed to by the InputNode
+         * Property. When the value of the Variable referenced by the InputNode Property is not equal to the value of the
+         * NormalState Property the Alarm is Active.
+         *
+         * If this Variable is not in the AddressSpace, a NULL NodeId shall be provided.
+         *
+         */
+        if (options.normalState) {
+            const normalState = addressSpace._coerceNode(options.normalState);
+            const normalStateNodeId = normalState ? normalState.nodeId : new node_opcua_nodeid_1.NodeId();
+            alarmNode.normalState.setValueFromSource({ dataType: node_opcua_variant_1.DataType.NodeId, value: normalStateNodeId });
+            alarmNode.normalState.on("value_changed", (newDataValue /*, oldDataValue: DataValue*/) => {
+                // The node that contains the normalState value has changed.
+                //   we must remove the listener on current normalState and replace
+                //   normalState with the new one and set listener again
+                //   to do:
+            });
+            if (normalState) {
+                // install normalState monitoring for change
+                normalState.on("value_changed", (newDataValue /*, oldDataValue: DataValue*/) => {
+                    alarmNode._onNormalStateDataValueChange(newDataValue);
+                });
+            }
+        }
+        else {
+            alarmNode.normalState.setValueFromSource({ dataType: node_opcua_variant_1.DataType.NodeId, value: node_opcua_nodeid_1.NodeId.nullNodeId });
+        }
+        alarmNode._mayBe_updateAlarmState();
+        return alarmNode;
+    }
+    // HasProperty Variable NormalState NodeId PropertyType Mandatory
+    // The NormalState Property is a Property that points to a Variable which has a value that
+    // corresponds to one of the possible values of the Variable pointed to by the InputNode
+    // Property where the NormalState Property Variable value is the value that is considered to be
+    // the normal state of the Variable pointed to by the InputNode Property. When the value of the
+    // Variable referenced by the InputNode Property is not equal to the value of the NormalState
+    // Property the Alarm is Active. If this Variable is not in the AddressSpace, a Null NodeId shall
+    // be provided.
+    getNormalStateNode() {
+        const nodeId = this.normalState.readValue().value.value;
+        const node = this.addressSpace.findNode(nodeId);
+        if (!node) {
+            return null;
+        }
+        return node;
+    }
+    /**
+     * @method getNormalStateValue
+     */
+    getNormalStateValue() {
+        const normalStateNode = this.getNormalStateNode();
+        if (!normalStateNode) {
+            return null;
+        }
+        return normalStateNode.readValue().value.value;
+    }
+    /**
+     * @method setNormalStateValue
+     * @param value
+     */
+    setNormalStateValue(value) {
+        const normalStateNode = this.getNormalStateNode();
+        throw new Error("Not Implemented yet");
+    }
+    updateAlarmState(isActive, message) {
+        if (isActive === this.activeState.getValue()) {
+            // no change => ignore !
+            return;
+        }
+        const stateName = isActive ? "Active" : "Inactive";
+        // also raise the event
+        this._signalNewCondition(stateName, isActive, message);
+        if (!isActive) {
+            this.currentBranch().setRetain(false);
+        }
+    }
+    _mayBe_updateAlarmState(normalStateValue, inputValue) {
+        if (utils.isNullOrUndefined(normalStateValue) || utils.isNullOrUndefined(inputValue)) {
+            this.activeState.setValue(false);
+            return;
+        }
+        const isActive = !isEqual(normalStateValue, inputValue);
+        this.updateAlarmState(isActive, "automatique update");
+    }
+    _onInputDataValueChange(dataValue) {
+        if (dataValue.statusCode !== node_opcua_status_code_1.StatusCodes.Good) {
+            // what shall we do ?
+            return;
+        }
+        if (dataValue.value.dataType === node_opcua_variant_1.DataType.Null) {
+            // what shall we do ?
+            return;
+        }
+        const inputValue = dataValue.value.value;
+        const normalStateValue = this.getNormalStateValue();
+        this._mayBe_updateAlarmState(normalStateValue, inputValue);
+    }
+    _onNormalStateDataValueChange(dataValue) {
+        if (dataValue.statusCode !== node_opcua_status_code_1.StatusCodes.Good) {
+            // what shall we do ?
+            return;
+        }
+        if (dataValue.value.dataType === node_opcua_variant_1.DataType.Null) {
+            // what shall we do ?
+            return;
+        }
+        const normalStateValue = dataValue.value.value;
+        const inputValue = this.getInputNodeValue();
+        this._mayBe_updateAlarmState(normalStateValue, inputValue);
+    }
+}
+exports.UAOffNormalAlarmImpl = UAOffNormalAlarmImpl;
 //# sourceMappingURL=ua_off_normal_alarm_impl.js.map

package/dist/src/alarms_and_conditions/ua_system_off_normal_alarm_impl.d.ts

@@ -1,18 +1,18 @@
-/**
- * @module node-opcua-address-space.AlarmsAndConditions
- */
-import { INamespace } from "node-opcua-address-space-base";
-import { NodeId } from "node-opcua-nodeid";
-import { VariantOptions } from "node-opcua-variant";
-import { InstantiateOffNormalAlarmOptions } from "../../source/interfaces/alarms_and_conditions/instantiate_off_normal_alarm_options";
-import { UAOffNormalAlarmImpl } from "./ua_off_normal_alarm_impl";
-/**
- *
- * This Condition is used by a Server to indicate that an underlying system that is providing  Alarm information is
- * having a communication problem and that the Server may have invalid or incomplete Condition state in the
- * Subscription.
- *
- */
-export declare class UASystemOffNormalAlarmImpl extends UAOffNormalAlarmImpl {
-    static instantiate(namespace: INamespace, limitAlarmTypeId: string | NodeId, options: InstantiateOffNormalAlarmOptions, data?: Record<string, VariantOptions>): UASystemOffNormalAlarmImpl;
-}
+/**
+ * @module node-opcua-address-space.AlarmsAndConditions
+ */
+import { INamespace } from "node-opcua-address-space-base";
+import { NodeId } from "node-opcua-nodeid";
+import { VariantOptions } from "node-opcua-variant";
+import { InstantiateOffNormalAlarmOptions } from "../../source/interfaces/alarms_and_conditions/instantiate_off_normal_alarm_options";
+import { UAOffNormalAlarmImpl } from "./ua_off_normal_alarm_impl";
+/**
+ *
+ * This Condition is used by a Server to indicate that an underlying system that is providing  Alarm information is
+ * having a communication problem and that the Server may have invalid or incomplete Condition state in the
+ * Subscription.
+ *
+ */
+export declare class UASystemOffNormalAlarmImpl extends UAOffNormalAlarmImpl {
+    static instantiate(namespace: INamespace, limitAlarmTypeId: string | NodeId, options: InstantiateOffNormalAlarmOptions, data?: Record<string, VariantOptions>): UASystemOffNormalAlarmImpl;
+}

package/dist/src/alarms_and_conditions/ua_system_off_normal_alarm_impl.js

@@ -1,18 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UASystemOffNormalAlarmImpl = void 0;
-const ua_off_normal_alarm_impl_1 = require("./ua_off_normal_alarm_impl");
-/**
- *
- * This Condition is used by a Server to indicate that an underlying system that is providing  Alarm information is
- * having a communication problem and that the Server may have invalid or incomplete Condition state in the
- * Subscription.
- *
- */
-class UASystemOffNormalAlarmImpl extends ua_off_normal_alarm_impl_1.UAOffNormalAlarmImpl {
-    static instantiate(namespace, limitAlarmTypeId, options, data) {
-        return ua_off_normal_alarm_impl_1.UAOffNormalAlarmImpl.instantiate(namespace, limitAlarmTypeId, options, data);
-    }
-}
-exports.UASystemOffNormalAlarmImpl = UASystemOffNormalAlarmImpl;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UASystemOffNormalAlarmImpl = void 0;
+const ua_off_normal_alarm_impl_1 = require("./ua_off_normal_alarm_impl");
+/**
+ *
+ * This Condition is used by a Server to indicate that an underlying system that is providing  Alarm information is
+ * having a communication problem and that the Server may have invalid or incomplete Condition state in the
+ * Subscription.
+ *
+ */
+class UASystemOffNormalAlarmImpl extends ua_off_normal_alarm_impl_1.UAOffNormalAlarmImpl {
+    static instantiate(namespace, limitAlarmTypeId, options, data) {
+        return ua_off_normal_alarm_impl_1.UAOffNormalAlarmImpl.instantiate(namespace, limitAlarmTypeId, options, data);
+    }
+}
+exports.UASystemOffNormalAlarmImpl = UASystemOffNormalAlarmImpl;
 //# sourceMappingURL=ua_system_off_normal_alarm_impl.js.map

package/dist/src/apply_condition_refresh.d.ts

@@ -1,6 +1,6 @@
-import { UAObject } from "node-opcua-address-space-base";
-import { BaseNodeImpl } from "./base_node_impl";
-export declare type ConditionRefreshCache = {
-    [key in string]: UAObject;
-};
-export declare function apply_condition_refresh(this: BaseNodeImpl, _cache?: ConditionRefreshCache): void;
+import { UAObject } from "node-opcua-address-space-base";
+import { BaseNodeImpl } from "./base_node_impl";
+export declare type ConditionRefreshCache = {
+    [key in string]: UAObject;
+};
+export declare function apply_condition_refresh(this: BaseNodeImpl, _cache?: ConditionRefreshCache): void;

package/dist/src/apply_condition_refresh.js

@@ -1,28 +1,28 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.apply_condition_refresh = void 0;
-const ua_condition_impl_1 = require("./alarms_and_conditions/ua_condition_impl");
-function apply_condition_refresh(_cache) {
-    // visit all notifiers recursively
-    _cache = _cache || {};
-    const notifiers = this.getNotifiers();
-    const eventSources = this.getEventSources();
-    const conditions = this.findReferencesAsObject("HasCondition", true);
-    for (const condition of conditions) {
-        if (condition instanceof ua_condition_impl_1.UAConditionImpl) {
-            condition._resend_conditionEvents();
-        }
-    }
-    const arr = [].concat(notifiers, eventSources);
-    for (const notifier of arr) {
-        const key = notifier.nodeId.toString();
-        if (!_cache[key]) {
-            _cache[key] = notifier;
-            if (notifier._conditionRefresh) {
-                notifier._conditionRefresh(_cache);
-            }
-        }
-    }
-}
-exports.apply_condition_refresh = apply_condition_refresh;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apply_condition_refresh = void 0;
+const ua_condition_impl_1 = require("./alarms_and_conditions/ua_condition_impl");
+function apply_condition_refresh(_cache) {
+    // visit all notifiers recursively
+    _cache = _cache || {};
+    const notifiers = this.getNotifiers();
+    const eventSources = this.getEventSources();
+    const conditions = this.findReferencesAsObject("HasCondition", true);
+    for (const condition of conditions) {
+        if (condition instanceof ua_condition_impl_1.UAConditionImpl) {
+            condition._resend_conditionEvents();
+        }
+    }
+    const arr = [].concat(notifiers, eventSources);
+    for (const notifier of arr) {
+        const key = notifier.nodeId.toString();
+        if (!_cache[key]) {
+            _cache[key] = notifier;
+            if (notifier._conditionRefresh) {
+                notifier._conditionRefresh(_cache);
+            }
+        }
+    }
+}
+exports.apply_condition_refresh = apply_condition_refresh;
 //# sourceMappingURL=apply_condition_refresh.js.map