node-opcua-address-space 2.71.0 → 2.72.2

package/dist/src/alarms_and_conditions/ua_alarm_condition_impl.js

@@ -1,417 +1,417 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UAAlarmConditionImpl = void 0;
-/**
- * @module node-opcua-address-space.AlarmsAndConditions
- */
-const lodash_1 = require("lodash");
-const node_opcua_assert_1 = require("node-opcua-assert");
-const node_opcua_data_model_1 = require("node-opcua-data-model");
-const node_opcua_nodeid_1 = require("node-opcua-nodeid");
-const node_opcua_status_code_1 = require("node-opcua-status-code");
-const node_opcua_variant_1 = require("node-opcua-variant");
-const ua_two_state_variable_1 = require("../state_machine/ua_two_state_variable");
-const ua_shelving_state_machine_ex_1 = require("../state_machine/ua_shelving_state_machine_ex");
-const condition_info_1 = require("./condition_info");
-const ua_acknowledgeable_condition_impl_1 = require("./ua_acknowledgeable_condition_impl");
-function _update_suppressedOrShelved(alarmNode) {
-    alarmNode.suppressedOrShelved.setValueFromSource({
-        dataType: node_opcua_variant_1.DataType.Boolean,
-        value: alarmNode.isSuppressedOrShelved()
-    });
-}
-class UAAlarmConditionImpl extends ua_acknowledgeable_condition_impl_1.UAAcknowledgeableConditionImpl {
-    static instantiate(namespace, alarmConditionTypeId, options, data) {
-        const addressSpace = namespace.addressSpace;
-        // xx assert(Object.prototype.hasOwnProperty.call(options,"conditionOf")); // must provide a conditionOf
-        (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(options, "inputNode")); // must provide a inputNode
-        const alarmConditionType = addressSpace.findEventType(alarmConditionTypeId);
-        /* istanbul ignore next */
-        if (!alarmConditionType) {
-            throw new Error(" cannot find Alarm Condition Type for " + alarmConditionTypeId);
-        }
-        const alarmConditionTypeBase = addressSpace.findEventType("AlarmConditionType");
-        /* istanbul ignore next */
-        if (!alarmConditionTypeBase) {
-            throw new Error("cannot find AlarmConditionType");
-        }
-        options.optionals = options.optionals || [];
-        if (Object.prototype.hasOwnProperty.call(options, "maxTimeShelved")) {
-            options.optionals.push("MaxTimeShelved");
-            (0, node_opcua_assert_1.assert)(isFinite(options.maxTimeShelved));
-        }
-        (0, node_opcua_assert_1.assert)(alarmConditionTypeBase === alarmConditionType || alarmConditionType.isSupertypeOf(alarmConditionTypeBase));
-        const alarmNode = ua_acknowledgeable_condition_impl_1.UAAcknowledgeableConditionImpl.instantiate(namespace, alarmConditionTypeId, options, data);
-        Object.setPrototypeOf(alarmNode, UAAlarmConditionImpl.prototype);
-        // ----------------------- Install Alarm specifics
-        //
-        // Specs 1.03:
-        // ActiveState/Id when set to TRUE indicates that the situation the Condition is representing
-        // currently exists. When a Condition instance is in the inactive state (ActiveState/Id when set to
-        // FALSE) it is representing a situation that has returned to a normal state. The transitions of
-        // Conditions to the inactive and Active states are triggered by Server specific actions. Sub-
-        // Types of the AlarmConditionType specified later in this document will have sub-state models
-        // that further define the Active state. Recommended state names are described in Annex A.
-        // install activeState - Mandatory
-        /**
-         * @property activeState
-         * @type {UATwoStateVariable}
-         */
-        (0, ua_two_state_variable_1._install_TwoStateVariable_machinery)(alarmNode.activeState, {
-            falseState: "Inactive",
-            trueState: "Active"
-        });
-        alarmNode.currentBranch().setActiveState(false);
-        // Specs 1.03:
-        /**
-         *
-         * SuppressState is used internally by a Server to automatically suppress Alarms due to system
-         * specific reasons. For example a system may be configured to suppress Alarms that are
-         * associated with machinery that is shutdown, such as a low level Alarm for a tank that is
-         * currently not in use.
-         *
-         * @property suppressedState
-         * @type UATwoStateVariable
-         */
-        if (alarmNode.suppressedState) {
-            // install activeState - Optional
-            (0, ua_two_state_variable_1._install_TwoStateVariable_machinery)(alarmNode.suppressedState, {
-                falseState: "Unsuppressed",
-                trueState: "Suppressed"
-            });
-        }
-        // Specs 1.03:
-        /**
-         * ShelvingState suggests whether an Alarm shall (temporarily) be prevented from being
-         * displayed to the user. It is quite often used to block nuisance Alarms.
-         *
-         * @property shelvingState
-         * @type ShelvingStateMachine
-         */
-        if (alarmNode.shelvingState) {
-            ua_shelving_state_machine_ex_1.UAShelvedStateMachineEx.promote(alarmNode.shelvingState);
-        }
-        // SuppressedOrShelved : Mandatory
-        // install suppressedOrShelved automatic detection
-        /**
-         * The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the
-         * Condition. When an Alarm is in one of the states, the SuppressedOrShelved property will be set TRUE
-         * and this Alarm is then typically not displayed by the Client. State transitions associated with the
-         * Alarm do occur, but they are not typically displayed by the Clients as long as the Alarm remains in
-         * either the Suppressed or Shelved state.
-         * The dataType is Boolean.
-         * @property suppressedState
-         * @type UAVariable
-         *
-         */
-        if (alarmNode.suppressedState) {
-            alarmNode.suppressedState.on("value_changed", (newDataValue) => {
-                _update_suppressedOrShelved(alarmNode);
-            });
-        }
-        if (alarmNode.shelvingState) {
-            alarmNode.shelvingState.currentState.on("value_changed", (newDataValue) => {
-                _update_suppressedOrShelved(alarmNode);
-            });
-        }
-        _update_suppressedOrShelved(alarmNode);
-        /**
-         * The optional Property MaxTimeShelved is used to set the maximum time that an Alarm Condition may be shelved.
-         * The value is expressed as duration. Systems can use this Property to prevent permanent Shelving of an Alarm.
-         * If this Property is present it will be an upper limit on the duration passed into a TimedShelve Method call.
-         * If a value that exceeds the value of this property is passed to the TimedShelve Method,
-         * than a BadShelvingTimeOutOfRange error code is returned on the call. If this Property is present it will
-         * also be enforced for the OneShotShelved state, in that an Alarm Condition will transition to the Unshelved
-         * state from the OneShotShelved state if the duration specified in this Property expires following a
-         * OneShotShelve operation without a change of any of the other items associated with the Condition.
-         *
-         * @property maxTimeShelved
-         * @type {UAVariable}
-         */
-        if (alarmNode.maxTimeShelved) {
-            options.maxTimeShelved = options.maxTimeShelved || 60.0 * 1000; // 60 seconds
-            alarmNode.maxTimeShelved.setValueFromSource({
-                dataType: "Duration",
-                value: options.maxTimeShelved
-            });
-        }
-        // ---------- install inputNode
-        (0, node_opcua_assert_1.assert)(options.inputNode, " must provide options.inputNode (NodeId or BaseNode object)");
-        alarmNode.installInputNodeMonitoring(options.inputNode);
-        (0, node_opcua_assert_1.assert)(alarmNode instanceof ua_acknowledgeable_condition_impl_1.UAAcknowledgeableConditionImpl);
-        (0, node_opcua_assert_1.assert)(alarmNode instanceof UAAlarmConditionImpl);
-        return alarmNode;
-    }
-    dispose() {
-        if (this.shelvingState) {
-            (0, ua_shelving_state_machine_ex_1._clear_timer_if_any)(this.shelvingState);
-        }
-        super.dispose();
-    }
-    activateAlarm() {
-        // will set acknowledgeable to false and retain to true
-        const branch = this.currentBranch();
-        branch.setRetain(true);
-        branch.setActiveState(true);
-        branch.setAckedState(false);
-    }
-    deactivateAlarm() {
-        const branch = this.currentBranch();
-        branch.setRetain(true);
-        branch.setActiveState(false);
-    }
-    /**
-     * @deprecated use deactivateAlarm instead (with no s after de-activate)
-     */
-    desactivateAlarm() {
-        this.deactivateAlarm();
-    }
-    isSuppressedOrShelved() {
-        let suppressed = false;
-        if (this.suppressedState) {
-            suppressed = this.suppressedState.id.readValue().value.value;
-        }
-        let shelved = false;
-        if (this.shelvingState) {
-            const shelvedValue = this.shelvingState.currentState.readValue().value.value;
-            if (shelvedValue && shelvedValue.text !== "Unshelved") {
-                shelved = true;
-            }
-            // console.log("shelved = shelved",shelvedValue,shelved);
-        }
-        // xx console.log(" isSuppressedOrShelved ",suppressed,shelved);
-        return suppressed || shelved;
-    }
-    getSuppressedOrShelved() {
-        return this.suppressedOrShelved.readValue().value.value;
-    }
-    /**
-     *
-     * note: duration must be greater than 10ms and lesser than 2**31 ms
-     */
-    setMaxTimeShelved(duration) {
-        var _a;
-        if (duration < 10 || duration >= Math.pow(2, 31)) {
-            throw new Error(" Invalid maxTimeShelved duration: " + duration + "  must be [10,2**31] ");
-        }
-        (_a = this.maxTimeShelved) === null || _a === void 0 ? void 0 : _a.setValueFromSource({
-            dataType: "Duration",
-            value: duration
-        });
-    }
-    /**
-     * note: return a  Duration
-     */
-    getMaxTimeShelved() {
-        if (!this.maxTimeShelved) {
-            // if maxTimeShelved is not provided we assume MaxDuration
-            (0, node_opcua_assert_1.assert)(UAAlarmConditionImpl.MaxDuration <= 2147483648, "MaxDuration cannot be greater than 2**31");
-            return UAAlarmConditionImpl.MaxDuration;
-        }
-        const dataValue = this.maxTimeShelved.readValue();
-        (0, node_opcua_assert_1.assert)(dataValue.value.dataType === node_opcua_variant_1.DataType.Double); // Double <= Duration
-        return dataValue.value.value;
-    }
-    /**
-     * @method getInputNodeNode
-     * @return {BaseNode} return the node in the address space pointed by the inputNode value
-     *
-     * Note: please note the difference between alarm.inputNode
-     *    *  alarm.inputNode is a UAVariable property of the alarm object holding the nodeid of the input
-     *       node in its value.
-     *    *  getInputNodeNode() is the UAVariable that contains the value that affects the state of the alarm and
-     *       whose node id is stored in alarm.inputNode
-     */
-    getInputNodeNode() {
-        const nodeId = this.inputNode.readValue().value.value;
-        (0, node_opcua_assert_1.assert)(nodeId instanceof node_opcua_nodeid_1.NodeId || nodeId === null);
-        return this.addressSpace.findNode(nodeId);
-    }
-    /**
-     * @method getInputNodeValue
-     * @return {*}
-     */
-    getInputNodeValue() {
-        const node = this.getInputNodeNode();
-        if (!node) {
-            return null;
-        }
-        (0, node_opcua_assert_1.assert)(node.nodeClass === node_opcua_data_model_1.NodeClass.Variable);
-        return node.readValue().value.value;
-    }
-    updateState() {
-        const node = this.getInputNodeNode();
-        const dataValue = node.readValue();
-        this._onInputDataValueChange(dataValue);
-    }
-    _onInputDataValueChange(newValue) {
-        // xx console.log("class=",this.constructor.name,this.browseName.toString());
-        // xx throw new Error("_onInputDataValueChange must be overridden");
-    }
-    /**
-     * @method installInputNodeMonitoring
-     * install mechanism that listen to input node datavalue changes so that alarm status
-     * can be automatically updated appropriatly.
-     * @param inputNode {BaseNode}
-     * @return {void}
-     * @protected
-     */
-    installInputNodeMonitoring(inputNode) {
-        /**
-         *
-         * 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 Address Space,
-         * 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.
-         * dataType is DataType.NodeId
-         * @property inputNode
-         * @type     UAVariable
-         */
-        (0, node_opcua_assert_1.assert)(this.inputNode.nodeClass === node_opcua_data_model_1.NodeClass.Variable);
-        const addressSpace = this.addressSpace;
-        (0, node_opcua_assert_1.assert)(inputNode, " must provide options.inputNode (NodeId or BaseNode object)");
-        if (inputNode instanceof node_opcua_nodeid_1.NodeId) {
-            this.inputNode.setValueFromSource({
-                dataType: node_opcua_variant_1.DataType.NodeId,
-                value: inputNode
-            });
-        }
-        else {
-            this.inputNode.setValueFromSource({
-                dataType: "NodeId",
-                value: inputNode.nodeId
-            });
-            const _node = addressSpace._coerceNode(inputNode);
-            if (_node === null) {
-                // tslint:disable-next-line:no-console
-                console.log(" cannot find nodeId ", inputNode);
-            }
-            else {
-                (0, node_opcua_assert_1.assert)(_node, "Expecting a valid input node");
-                this.inputNode.setValueFromSource({
-                    dataType: node_opcua_variant_1.DataType.NodeId,
-                    value: _node.nodeId
-                });
-            }
-            const inputNode2 = this.getInputNodeNode();
-            if (!inputNode2 || inputNode2 === null) {
-                throw new Error("Invalid input node");
-            }
-            inputNode2.on("value_changed", (newDataValue /*, oldDataValue */) => {
-                if (!this.getEnabledState()) {
-                    // disabled alarms shall ignored input node value change event
-                    // (alarm shall be reevaluated when EnabledState goes back to true)
-                    return;
-                }
-                this._onInputDataValueChange(newDataValue);
-            });
-        }
-    }
-    getCurrentConditionInfo() {
-        const oldSeverity = this.currentBranch().getSeverity();
-        const oldQuality = this.currentBranch().getQuality();
-        const oldMessage = this.currentBranch().getMessage();
-        const oldRetain = this.currentBranch().getRetain();
-        const oldConditionInfo = new condition_info_1.ConditionInfo({
-            message: oldMessage,
-            quality: oldQuality,
-            retain: oldRetain,
-            severity: oldSeverity
-        });
-        return oldConditionInfo;
-    }
-    /***
-     * @method  _calculateConditionInfo
-     * @param stateData {Object}   the new calculated state of the alarm
-     * @param isActive  {Boolean}
-     * @param value     {Number}   the new value of the limit alarm
-     * @param oldCondition  {ConditionInfo} given for information purpose
-     * @param oldCondition.severity
-     * @param oldCondition.quality
-     * @param oldCondition.message
-     * @param oldCondition.retain
-     * @return {ConditionInfo} the new condition info
-     *
-     * this method need to be overridden by the instantiate to allow custom message and severity
-     * to be set based on specific context of the alarm.
-     *
-     * @example
-     *
-     *
-     *    var myAlarm = addressSpace.instantiateExclusiveLimitAlarm({...});
-     *    myAlarm._calculateConditionInfo = function(stateName,value,oldCondition) {
-     *       var percent = Math.ceil(value * 100);
-     *       return new ConditionInfo({
-     *            message: "Tank is almost " + percent + "% full",
-     *            severity: 100,
-     *            quality: StatusCodes.Good
-     *      });
-     *    };
-     *
-     */
-    _calculateConditionInfo(stateData, isActive, value, oldCondition) {
-        if (!stateData) {
-            return new condition_info_1.ConditionInfo({
-                message: "Back to normal",
-                quality: node_opcua_status_code_1.StatusCodes.Good,
-                retain: true,
-                severity: 0
-            });
-        }
-        else {
-            return new condition_info_1.ConditionInfo({
-                message: "Condition value is " + value + " and state is " + stateData,
-                quality: node_opcua_status_code_1.StatusCodes.Good,
-                retain: true,
-                severity: 150
-            });
-        }
-    }
-    _signalInitialCondition() {
-        this.currentBranch().setActiveState(false);
-        this.currentBranch().setAckedState(true);
-    }
-    _signalNewCondition(stateName, isActive, value) {
-        // xx if(stateName === null) {
-        // xx     alarm.currentBranch().setActiveState(false);
-        // xx     alarm.currentBranch().setAckedState(true);
-        // xx     return;
-        // xx }
-        // disabled alarm shall not generate new condition events
-        (0, node_opcua_assert_1.assert)(this.getEnabledState() === true);
-        // xx assert(isActive !== alarm.activeState.getValue());
-        const oldConditionInfo = this.getCurrentConditionInfo();
-        const newConditionInfo = this._calculateConditionInfo(stateName, !!isActive, value, oldConditionInfo);
-        // detect potential internal bugs due to misused of _signalNewCondition
-        if ((0, lodash_1.isEqual)(oldConditionInfo, newConditionInfo)) {
-            // tslint:disable-next-line:no-console
-            console.log(oldConditionInfo);
-            throw new Error("condition values have not change, shall we really raise an event ? alarm " + this.browseName.toString());
-        }
-        (0, node_opcua_assert_1.assert)(!(0, lodash_1.isEqual)(oldConditionInfo, newConditionInfo), "condition values have not change, shall we really raise an event ?");
-        if (isActive) {
-            this.currentBranch().setActiveState(true);
-            this.currentBranch().setAckedState(false);
-            this.raiseNewCondition(newConditionInfo);
-        }
-        else {
-            if (this.currentBranch().getAckedState() === false) {
-                // prior state need acknowledgement
-                // note : TODO : timestamp of branch and new state of current branch must be identical
-                if (this.currentBranch().getRetain()) {
-                    // we need to create a new branch so the previous state could be acknowledged
-                    const newBranch = this.createBranch();
-                    (0, node_opcua_assert_1.assert)(!(0, node_opcua_nodeid_1.sameNodeId)(newBranch.getBranchId(), node_opcua_nodeid_1.NodeId.nullNodeId));
-                    // also raised a new Event for the new branch as branchId has changed
-                    this.raiseNewBranchState(newBranch);
-                }
-            }
-            this.currentBranch().setActiveState(false);
-            this.currentBranch().setAckedState(true);
-            this.raiseNewCondition(newConditionInfo);
-        }
-    }
-}
-exports.UAAlarmConditionImpl = UAAlarmConditionImpl;
-UAAlarmConditionImpl.MaxDuration = Math.pow(2, 31);
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UAAlarmConditionImpl = void 0;
+/**
+ * @module node-opcua-address-space.AlarmsAndConditions
+ */
+const lodash_1 = require("lodash");
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_data_model_1 = require("node-opcua-data-model");
+const node_opcua_nodeid_1 = require("node-opcua-nodeid");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+const node_opcua_variant_1 = require("node-opcua-variant");
+const ua_two_state_variable_1 = require("../state_machine/ua_two_state_variable");
+const ua_shelving_state_machine_ex_1 = require("../state_machine/ua_shelving_state_machine_ex");
+const condition_info_1 = require("./condition_info");
+const ua_acknowledgeable_condition_impl_1 = require("./ua_acknowledgeable_condition_impl");
+function _update_suppressedOrShelved(alarmNode) {
+    alarmNode.suppressedOrShelved.setValueFromSource({
+        dataType: node_opcua_variant_1.DataType.Boolean,
+        value: alarmNode.isSuppressedOrShelved()
+    });
+}
+class UAAlarmConditionImpl extends ua_acknowledgeable_condition_impl_1.UAAcknowledgeableConditionImpl {
+    static instantiate(namespace, alarmConditionTypeId, options, data) {
+        const addressSpace = namespace.addressSpace;
+        // xx assert(Object.prototype.hasOwnProperty.call(options,"conditionOf")); // must provide a conditionOf
+        (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(options, "inputNode")); // must provide a inputNode
+        const alarmConditionType = addressSpace.findEventType(alarmConditionTypeId);
+        /* istanbul ignore next */
+        if (!alarmConditionType) {
+            throw new Error(" cannot find Alarm Condition Type for " + alarmConditionTypeId);
+        }
+        const alarmConditionTypeBase = addressSpace.findEventType("AlarmConditionType");
+        /* istanbul ignore next */
+        if (!alarmConditionTypeBase) {
+            throw new Error("cannot find AlarmConditionType");
+        }
+        options.optionals = options.optionals || [];
+        if (Object.prototype.hasOwnProperty.call(options, "maxTimeShelved")) {
+            options.optionals.push("MaxTimeShelved");
+            (0, node_opcua_assert_1.assert)(isFinite(options.maxTimeShelved));
+        }
+        (0, node_opcua_assert_1.assert)(alarmConditionTypeBase === alarmConditionType || alarmConditionType.isSupertypeOf(alarmConditionTypeBase));
+        const alarmNode = ua_acknowledgeable_condition_impl_1.UAAcknowledgeableConditionImpl.instantiate(namespace, alarmConditionTypeId, options, data);
+        Object.setPrototypeOf(alarmNode, UAAlarmConditionImpl.prototype);
+        // ----------------------- Install Alarm specifics
+        //
+        // Specs 1.03:
+        // ActiveState/Id when set to TRUE indicates that the situation the Condition is representing
+        // currently exists. When a Condition instance is in the inactive state (ActiveState/Id when set to
+        // FALSE) it is representing a situation that has returned to a normal state. The transitions of
+        // Conditions to the inactive and Active states are triggered by Server specific actions. Sub-
+        // Types of the AlarmConditionType specified later in this document will have sub-state models
+        // that further define the Active state. Recommended state names are described in Annex A.
+        // install activeState - Mandatory
+        /**
+         * @property activeState
+         * @type {UATwoStateVariable}
+         */
+        (0, ua_two_state_variable_1._install_TwoStateVariable_machinery)(alarmNode.activeState, {
+            falseState: "Inactive",
+            trueState: "Active"
+        });
+        alarmNode.currentBranch().setActiveState(false);
+        // Specs 1.03:
+        /**
+         *
+         * SuppressState is used internally by a Server to automatically suppress Alarms due to system
+         * specific reasons. For example a system may be configured to suppress Alarms that are
+         * associated with machinery that is shutdown, such as a low level Alarm for a tank that is
+         * currently not in use.
+         *
+         * @property suppressedState
+         * @type UATwoStateVariable
+         */
+        if (alarmNode.suppressedState) {
+            // install activeState - Optional
+            (0, ua_two_state_variable_1._install_TwoStateVariable_machinery)(alarmNode.suppressedState, {
+                falseState: "Unsuppressed",
+                trueState: "Suppressed"
+            });
+        }
+        // Specs 1.03:
+        /**
+         * ShelvingState suggests whether an Alarm shall (temporarily) be prevented from being
+         * displayed to the user. It is quite often used to block nuisance Alarms.
+         *
+         * @property shelvingState
+         * @type ShelvingStateMachine
+         */
+        if (alarmNode.shelvingState) {
+            ua_shelving_state_machine_ex_1.UAShelvedStateMachineEx.promote(alarmNode.shelvingState);
+        }
+        // SuppressedOrShelved : Mandatory
+        // install suppressedOrShelved automatic detection
+        /**
+         * The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the
+         * Condition. When an Alarm is in one of the states, the SuppressedOrShelved property will be set TRUE
+         * and this Alarm is then typically not displayed by the Client. State transitions associated with the
+         * Alarm do occur, but they are not typically displayed by the Clients as long as the Alarm remains in
+         * either the Suppressed or Shelved state.
+         * The dataType is Boolean.
+         * @property suppressedState
+         * @type UAVariable
+         *
+         */
+        if (alarmNode.suppressedState) {
+            alarmNode.suppressedState.on("value_changed", (newDataValue) => {
+                _update_suppressedOrShelved(alarmNode);
+            });
+        }
+        if (alarmNode.shelvingState) {
+            alarmNode.shelvingState.currentState.on("value_changed", (newDataValue) => {
+                _update_suppressedOrShelved(alarmNode);
+            });
+        }
+        _update_suppressedOrShelved(alarmNode);
+        /**
+         * The optional Property MaxTimeShelved is used to set the maximum time that an Alarm Condition may be shelved.
+         * The value is expressed as duration. Systems can use this Property to prevent permanent Shelving of an Alarm.
+         * If this Property is present it will be an upper limit on the duration passed into a TimedShelve Method call.
+         * If a value that exceeds the value of this property is passed to the TimedShelve Method,
+         * than a BadShelvingTimeOutOfRange error code is returned on the call. If this Property is present it will
+         * also be enforced for the OneShotShelved state, in that an Alarm Condition will transition to the Unshelved
+         * state from the OneShotShelved state if the duration specified in this Property expires following a
+         * OneShotShelve operation without a change of any of the other items associated with the Condition.
+         *
+         * @property maxTimeShelved
+         * @type {UAVariable}
+         */
+        if (alarmNode.maxTimeShelved) {
+            options.maxTimeShelved = options.maxTimeShelved || 60.0 * 1000; // 60 seconds
+            alarmNode.maxTimeShelved.setValueFromSource({
+                dataType: "Duration",
+                value: options.maxTimeShelved
+            });
+        }
+        // ---------- install inputNode
+        (0, node_opcua_assert_1.assert)(options.inputNode, " must provide options.inputNode (NodeId or BaseNode object)");
+        alarmNode.installInputNodeMonitoring(options.inputNode);
+        (0, node_opcua_assert_1.assert)(alarmNode instanceof ua_acknowledgeable_condition_impl_1.UAAcknowledgeableConditionImpl);
+        (0, node_opcua_assert_1.assert)(alarmNode instanceof UAAlarmConditionImpl);
+        return alarmNode;
+    }
+    dispose() {
+        if (this.shelvingState) {
+            (0, ua_shelving_state_machine_ex_1._clear_timer_if_any)(this.shelvingState);
+        }
+        super.dispose();
+    }
+    activateAlarm() {
+        // will set acknowledgeable to false and retain to true
+        const branch = this.currentBranch();
+        branch.setRetain(true);
+        branch.setActiveState(true);
+        branch.setAckedState(false);
+    }
+    deactivateAlarm(retain) {
+        const branch = this.currentBranch();
+        branch.setRetain(retain === undefined ? true : retain);
+        branch.setActiveState(false);
+    }
+    /**
+     * @deprecated use deactivateAlarm instead (with no s after de-activate)
+     */
+    desactivateAlarm() {
+        this.deactivateAlarm();
+    }
+    isSuppressedOrShelved() {
+        let suppressed = false;
+        if (this.suppressedState) {
+            suppressed = this.suppressedState.id.readValue().value.value;
+        }
+        let shelved = false;
+        if (this.shelvingState) {
+            const shelvedValue = this.shelvingState.currentState.readValue().value.value;
+            if (shelvedValue && shelvedValue.text !== "Unshelved") {
+                shelved = true;
+            }
+            // console.log("shelved = shelved",shelvedValue,shelved);
+        }
+        // xx console.log(" isSuppressedOrShelved ",suppressed,shelved);
+        return suppressed || shelved;
+    }
+    getSuppressedOrShelved() {
+        return this.suppressedOrShelved.readValue().value.value;
+    }
+    /**
+     *
+     * note: duration must be greater than 10ms and lesser than 2**31 ms
+     */
+    setMaxTimeShelved(duration) {
+        var _a;
+        if (duration < 10 || duration >= Math.pow(2, 31)) {
+            throw new Error(" Invalid maxTimeShelved duration: " + duration + "  must be [10,2**31] ");
+        }
+        (_a = this.maxTimeShelved) === null || _a === void 0 ? void 0 : _a.setValueFromSource({
+            dataType: "Duration",
+            value: duration
+        });
+    }
+    /**
+     * note: return a  Duration
+     */
+    getMaxTimeShelved() {
+        if (!this.maxTimeShelved) {
+            // if maxTimeShelved is not provided we assume MaxDuration
+            (0, node_opcua_assert_1.assert)(UAAlarmConditionImpl.MaxDuration <= 2147483648, "MaxDuration cannot be greater than 2**31");
+            return UAAlarmConditionImpl.MaxDuration;
+        }
+        const dataValue = this.maxTimeShelved.readValue();
+        (0, node_opcua_assert_1.assert)(dataValue.value.dataType === node_opcua_variant_1.DataType.Double); // Double <= Duration
+        return dataValue.value.value;
+    }
+    /**
+     * @method getInputNodeNode
+     * @return {BaseNode} return the node in the address space pointed by the inputNode value
+     *
+     * Note: please note the difference between alarm.inputNode
+     *    *  alarm.inputNode is a UAVariable property of the alarm object holding the nodeid of the input
+     *       node in its value.
+     *    *  getInputNodeNode() is the UAVariable that contains the value that affects the state of the alarm and
+     *       whose node id is stored in alarm.inputNode
+     */
+    getInputNodeNode() {
+        const nodeId = this.inputNode.readValue().value.value;
+        (0, node_opcua_assert_1.assert)(nodeId instanceof node_opcua_nodeid_1.NodeId || nodeId === null);
+        return this.addressSpace.findNode(nodeId);
+    }
+    /**
+     * @method getInputNodeValue
+     * @return {*}
+     */
+    getInputNodeValue() {
+        const node = this.getInputNodeNode();
+        if (!node) {
+            return null;
+        }
+        (0, node_opcua_assert_1.assert)(node.nodeClass === node_opcua_data_model_1.NodeClass.Variable);
+        return node.readValue().value.value;
+    }
+    updateState() {
+        const node = this.getInputNodeNode();
+        const dataValue = node.readValue();
+        this._onInputDataValueChange(dataValue);
+    }
+    _onInputDataValueChange(newValue) {
+        // xx console.log("class=",this.constructor.name,this.browseName.toString());
+        // xx throw new Error("_onInputDataValueChange must be overridden");
+    }
+    /**
+     * @method installInputNodeMonitoring
+     * install mechanism that listen to input node datavalue changes so that alarm status
+     * can be automatically updated appropriatly.
+     * @param inputNode {BaseNode}
+     * @return {void}
+     * @protected
+     */
+    installInputNodeMonitoring(inputNode) {
+        /**
+         *
+         * 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 Address Space,
+         * 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.
+         * dataType is DataType.NodeId
+         * @property inputNode
+         * @type     UAVariable
+         */
+        (0, node_opcua_assert_1.assert)(this.inputNode.nodeClass === node_opcua_data_model_1.NodeClass.Variable);
+        const addressSpace = this.addressSpace;
+        (0, node_opcua_assert_1.assert)(inputNode, " must provide options.inputNode (NodeId or BaseNode object)");
+        if (inputNode instanceof node_opcua_nodeid_1.NodeId) {
+            this.inputNode.setValueFromSource({
+                dataType: node_opcua_variant_1.DataType.NodeId,
+                value: inputNode
+            });
+        }
+        else {
+            this.inputNode.setValueFromSource({
+                dataType: "NodeId",
+                value: inputNode.nodeId
+            });
+            const _node = addressSpace._coerceNode(inputNode);
+            if (_node === null) {
+                // tslint:disable-next-line:no-console
+                console.log(" cannot find nodeId ", inputNode);
+            }
+            else {
+                (0, node_opcua_assert_1.assert)(_node, "Expecting a valid input node");
+                this.inputNode.setValueFromSource({
+                    dataType: node_opcua_variant_1.DataType.NodeId,
+                    value: _node.nodeId
+                });
+            }
+            const inputNode2 = this.getInputNodeNode();
+            if (!inputNode2 || inputNode2 === null) {
+                throw new Error("Invalid input node");
+            }
+            inputNode2.on("value_changed", (newDataValue /*, oldDataValue */) => {
+                if (!this.getEnabledState()) {
+                    // disabled alarms shall ignored input node value change event
+                    // (alarm shall be reevaluated when EnabledState goes back to true)
+                    return;
+                }
+                this._onInputDataValueChange(newDataValue);
+            });
+        }
+    }
+    getCurrentConditionInfo() {
+        const oldSeverity = this.currentBranch().getSeverity();
+        const oldQuality = this.currentBranch().getQuality();
+        const oldMessage = this.currentBranch().getMessage();
+        const oldRetain = this.currentBranch().getRetain();
+        const oldConditionInfo = new condition_info_1.ConditionInfo({
+            message: oldMessage,
+            quality: oldQuality,
+            retain: oldRetain,
+            severity: oldSeverity
+        });
+        return oldConditionInfo;
+    }
+    /***
+     * @method  _calculateConditionInfo
+     * @param stateData {Object}   the new calculated state of the alarm
+     * @param isActive  {Boolean}
+     * @param value     {Number}   the new value of the limit alarm
+     * @param oldCondition  {ConditionInfo} given for information purpose
+     * @param oldCondition.severity
+     * @param oldCondition.quality
+     * @param oldCondition.message
+     * @param oldCondition.retain
+     * @return {ConditionInfo} the new condition info
+     *
+     * this method need to be overridden by the instantiate to allow custom message and severity
+     * to be set based on specific context of the alarm.
+     *
+     * @example
+     *
+     *
+     *    var myAlarm = addressSpace.instantiateExclusiveLimitAlarm({...});
+     *    myAlarm._calculateConditionInfo = function(stateName,value,oldCondition) {
+     *       var percent = Math.ceil(value * 100);
+     *       return new ConditionInfo({
+     *            message: "Tank is almost " + percent + "% full",
+     *            severity: 100,
+     *            quality: StatusCodes.Good
+     *      });
+     *    };
+     *
+     */
+    _calculateConditionInfo(stateData, isActive, value, oldCondition) {
+        if (!stateData) {
+            return new condition_info_1.ConditionInfo({
+                message: "Back to normal",
+                quality: node_opcua_status_code_1.StatusCodes.Good,
+                retain: true,
+                severity: 0
+            });
+        }
+        else {
+            return new condition_info_1.ConditionInfo({
+                message: "Condition value is " + value + " and state is " + stateData,
+                quality: node_opcua_status_code_1.StatusCodes.Good,
+                retain: true,
+                severity: 150
+            });
+        }
+    }
+    _signalInitialCondition() {
+        this.currentBranch().setActiveState(false);
+        this.currentBranch().setAckedState(true);
+    }
+    _signalNewCondition(stateName, isActive, value) {
+        // xx if(stateName === null) {
+        // xx     alarm.currentBranch().setActiveState(false);
+        // xx     alarm.currentBranch().setAckedState(true);
+        // xx     return;
+        // xx }
+        // disabled alarm shall not generate new condition events
+        (0, node_opcua_assert_1.assert)(this.getEnabledState() === true);
+        // xx assert(isActive !== alarm.activeState.getValue());
+        const oldConditionInfo = this.getCurrentConditionInfo();
+        const newConditionInfo = this._calculateConditionInfo(stateName, !!isActive, value, oldConditionInfo);
+        // detect potential internal bugs due to misused of _signalNewCondition
+        if ((0, lodash_1.isEqual)(oldConditionInfo, newConditionInfo)) {
+            // tslint:disable-next-line:no-console
+            console.log(oldConditionInfo);
+            throw new Error("condition values have not change, shall we really raise an event ? alarm " + this.browseName.toString());
+        }
+        (0, node_opcua_assert_1.assert)(!(0, lodash_1.isEqual)(oldConditionInfo, newConditionInfo), "condition values have not change, shall we really raise an event ?");
+        if (isActive) {
+            this.currentBranch().setActiveState(true);
+            this.currentBranch().setAckedState(false);
+            this.raiseNewCondition(newConditionInfo);
+        }
+        else {
+            if (this.currentBranch().getAckedState() === false) {
+                // prior state need acknowledgement
+                // note : TODO : timestamp of branch and new state of current branch must be identical
+                if (this.currentBranch().getRetain()) {
+                    // we need to create a new branch so the previous state could be acknowledged
+                    const newBranch = this.createBranch();
+                    (0, node_opcua_assert_1.assert)(!(0, node_opcua_nodeid_1.sameNodeId)(newBranch.getBranchId(), node_opcua_nodeid_1.NodeId.nullNodeId));
+                    // also raised a new Event for the new branch as branchId has changed
+                    this.raiseNewBranchState(newBranch);
+                }
+            }
+            this.currentBranch().setActiveState(false);
+            this.currentBranch().setAckedState(true);
+            this.raiseNewCondition(newConditionInfo);
+        }
+    }
+}
+exports.UAAlarmConditionImpl = UAAlarmConditionImpl;
+UAAlarmConditionImpl.MaxDuration = Math.pow(2, 31);
 //# sourceMappingURL=ua_alarm_condition_impl.js.map