node-opcua-address-space 2.71.0 → 2.72.2

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

@@ -1,5 +1,5 @@
-/// <reference types="node" />
-import { LocalizedText, LocalizedTextLike } from "node-opcua-data-model";
-import { StatusCode } from "node-opcua-status-code";
-import { ConditionSnapshot } from "./condition_snapshot";
-export declare function _setAckedState(self: ConditionSnapshot, requestedAckedState: boolean, conditionEventId?: Buffer, comment?: string | LocalizedText | LocalizedTextLike): StatusCode;
+/// <reference types="node" />
+import { LocalizedText, LocalizedTextLike } from "node-opcua-data-model";
+import { StatusCode } from "node-opcua-status-code";
+import { ConditionSnapshot } from "./condition_snapshot";
+export declare function _setAckedState(self: ConditionSnapshot, requestedAckedState: boolean, conditionEventId?: Buffer, comment?: string | LocalizedText | LocalizedTextLike): StatusCode;

package/dist/src/alarms_and_conditions/condition.js

@@ -1,81 +1,81 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports._setAckedState = void 0;
-/**
- * @module node-opcua-address-space.AlarmsAndConditions
- */
-// tslint:disable:no-console
-// tslint:disable:no-var-requires
-require("set-prototype-of");
-const node_opcua_assert_1 = require("node-opcua-assert");
-const node_opcua_factory_1 = require("node-opcua-factory");
-const node_opcua_status_code_1 = require("node-opcua-status-code");
-const condition_snapshot_1 = require("./condition_snapshot");
-function _setAckedState(self, requestedAckedState, conditionEventId, comment) {
-    (0, node_opcua_assert_1.assert)(self instanceof condition_snapshot_1.ConditionSnapshot);
-    const ackedState = self.getAckedState();
-    if (ackedState && requestedAckedState) {
-        return node_opcua_status_code_1.StatusCodes.BadConditionBranchAlreadyAcked;
-    }
-    self._set_twoStateVariable("ackedState", requestedAckedState);
-    return node_opcua_status_code_1.StatusCodes.Good;
-}
-exports._setAckedState = _setAckedState;
-// tslint:disable:max-classes-per-file
-function prepare_date(sourceTimestamp) {
-    if (!sourceTimestamp || !sourceTimestamp.value) {
-        return node_opcua_factory_1.minDate;
-    }
-    (0, node_opcua_assert_1.assert)(sourceTimestamp.value instanceof Date);
-    return sourceTimestamp;
-}
-/*
- As per spec OPCUA 1.03 part 9:
-
- A Condition’s EnabledState effects the generation of Event Notifications and as such results
- in the following specific behaviour:
- * When the Condition instance enters the Disabled state, the Retain Property of this
- Condition shall be set to FALSE by the Server to indicate to the Client that the
- Condition instance is currently not of interest to Clients.
- * When the Condition instance enters the enabled state, the Condition shall be
- evaluated and all of its Properties updated to reflect the current values. If this
- evaluation causes the Retain Property to transition to TRUE for any ConditionBranch,
- then an Event Notification shall be generated for that ConditionBranch.
- * The Server may choose to continue to test for a Condition instance while it is
- Disabled. However, no Event Notifications will be generated while the Condition
- instance is disabled.
- * For any Condition that exists in the Address Space the Attributes and the following
- Variables will continue to have valid values even in the Disabled state; EventId, Event
- Type, Source Node, Source Name, Time, and EnabledState.
- Other properties may no longer provide current valid values.
- All Variables that are no longer provided shall return a status of BadConditionDisabled.
- The Event that reports the Disabled state  should report the properties as NULL or with a status
- of BadConditionDisabled.
- When enabled, changes to the following components shall cause a ConditionType Event Notification:
- - Quality
- - Severity (inherited from BaseEventType)
- - Comment
-
- // spec :
- // The HasCondition ReferenceType is a concrete ReferenceType and can be used directly. It is
- // a subtype of NonHierarchicalReferences.
- // The semantic of this ReferenceType is to specify the relationship between a ConditionSource
- // and its Conditions. Each ConditionSource shall be the target of a HasEventSource Reference
- // or a sub type of HasEventSource. The Address Space organisation that shall be provided for
- // Clients to detect Conditions and ConditionSources is defined in Clause 6. Various examples
- // for the use of this ReferenceType can be found in B.2.
- // HasCondition References can be used in the Type definition of an Object or a Variable. In this
- // case, the SourceNode of this ReferenceType shall be an ObjectType or VariableType Node or
- // one of their InstanceDeclaration Nodes. The TargetNode shall be a Condition instance
- // declaration or a ConditionType. The following rules for instantiation apply:
- //  All HasCondition References used in a Type shall exist in instances of these Types as
- //    well.
- //  If the TargetNode in the Type definition is a ConditionType, the same TargetNode will
- //    be referenced on the instance.
- // HasCondition References may be used solely in the instance space when they are not
- // available in Type definitions. In this case the SourceNode of this ReferenceType shall be an
- // Object, Variable or Method Node. The TargetNode shall be a Condition instance or a
- // ConditionType.
-
- */
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._setAckedState = void 0;
+/**
+ * @module node-opcua-address-space.AlarmsAndConditions
+ */
+// tslint:disable:no-console
+// tslint:disable:no-var-requires
+require("set-prototype-of");
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_factory_1 = require("node-opcua-factory");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+const condition_snapshot_1 = require("./condition_snapshot");
+function _setAckedState(self, requestedAckedState, conditionEventId, comment) {
+    (0, node_opcua_assert_1.assert)(self instanceof condition_snapshot_1.ConditionSnapshot);
+    const ackedState = self.getAckedState();
+    if (ackedState && requestedAckedState) {
+        return node_opcua_status_code_1.StatusCodes.BadConditionBranchAlreadyAcked;
+    }
+    self._set_twoStateVariable("ackedState", requestedAckedState);
+    return node_opcua_status_code_1.StatusCodes.Good;
+}
+exports._setAckedState = _setAckedState;
+// tslint:disable:max-classes-per-file
+function prepare_date(sourceTimestamp) {
+    if (!sourceTimestamp || !sourceTimestamp.value) {
+        return node_opcua_factory_1.minDate;
+    }
+    (0, node_opcua_assert_1.assert)(sourceTimestamp.value instanceof Date);
+    return sourceTimestamp;
+}
+/*
+ As per spec OPCUA 1.03 part 9:
+
+ A Condition’s EnabledState effects the generation of Event Notifications and as such results
+ in the following specific behaviour:
+ * When the Condition instance enters the Disabled state, the Retain Property of this
+ Condition shall be set to FALSE by the Server to indicate to the Client that the
+ Condition instance is currently not of interest to Clients.
+ * When the Condition instance enters the enabled state, the Condition shall be
+ evaluated and all of its Properties updated to reflect the current values. If this
+ evaluation causes the Retain Property to transition to TRUE for any ConditionBranch,
+ then an Event Notification shall be generated for that ConditionBranch.
+ * The Server may choose to continue to test for a Condition instance while it is
+ Disabled. However, no Event Notifications will be generated while the Condition
+ instance is disabled.
+ * For any Condition that exists in the Address Space the Attributes and the following
+ Variables will continue to have valid values even in the Disabled state; EventId, Event
+ Type, Source Node, Source Name, Time, and EnabledState.
+ Other properties may no longer provide current valid values.
+ All Variables that are no longer provided shall return a status of BadConditionDisabled.
+ The Event that reports the Disabled state  should report the properties as NULL or with a status
+ of BadConditionDisabled.
+ When enabled, changes to the following components shall cause a ConditionType Event Notification:
+ - Quality
+ - Severity (inherited from BaseEventType)
+ - Comment
+
+ // spec :
+ // The HasCondition ReferenceType is a concrete ReferenceType and can be used directly. It is
+ // a subtype of NonHierarchicalReferences.
+ // The semantic of this ReferenceType is to specify the relationship between a ConditionSource
+ // and its Conditions. Each ConditionSource shall be the target of a HasEventSource Reference
+ // or a sub type of HasEventSource. The Address Space organisation that shall be provided for
+ // Clients to detect Conditions and ConditionSources is defined in Clause 6. Various examples
+ // for the use of this ReferenceType can be found in B.2.
+ // HasCondition References can be used in the Type definition of an Object or a Variable. In this
+ // case, the SourceNode of this ReferenceType shall be an ObjectType or VariableType Node or
+ // one of their InstanceDeclaration Nodes. The TargetNode shall be a Condition instance
+ // declaration or a ConditionType. The following rules for instantiation apply:
+ //  All HasCondition References used in a Type shall exist in instances of these Types as
+ //    well.
+ //  If the TargetNode in the Type definition is a ConditionType, the same TargetNode will
+ //    be referenced on the instance.
+ // HasCondition References may be used solely in the instance space when they are not
+ // available in Type definitions. In this case the SourceNode of this ReferenceType shall be an
+ // Object, Variable or Method Node. The TargetNode shall be a Condition instance or a
+ // ConditionType.
+
+ */
 //# sourceMappingURL=condition.js.map

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

@@ -1,27 +1,27 @@
-import { UInt16 } from "node-opcua-basic-types";
-import { LocalizedText } from "node-opcua-data-model";
-import { StatusCode } from "node-opcua-status-code";
-import { ConditionInfoOptions } from "../../source/interfaces/alarms_and_conditions/condition_info_i";
-export interface ConditionInfo {
-    message: LocalizedText | null;
-    quality: StatusCode | null;
-    severity: UInt16 | null;
-    retain: boolean | null;
-    isDifferentFrom(otherConditionInfo: ConditionInfo): boolean;
-}
-/**
- * @class ConditionInfo
- * @param options  {Object}
- * @param options.message   {String|LocalizedText} the event message
- * @param options.severity  {UInt16} severity
- * @param options.quality   {StatusCode} quality
- * @param options.retain   {Boolean} retain flag
- * @constructor
- */
-export declare class ConditionInfo {
-    message: LocalizedText | null;
-    quality: StatusCode | null;
-    severity: UInt16 | null;
-    retain: boolean | null;
-    constructor(options: ConditionInfoOptions);
-}
+import { UInt16 } from "node-opcua-basic-types";
+import { LocalizedText } from "node-opcua-data-model";
+import { StatusCode } from "node-opcua-status-code";
+import { ConditionInfoOptions } from "../../source/interfaces/alarms_and_conditions/condition_info_i";
+export interface ConditionInfo {
+    message: LocalizedText | null;
+    quality: StatusCode | null;
+    severity: UInt16 | null;
+    retain: boolean | null;
+    isDifferentFrom(otherConditionInfo: ConditionInfo): boolean;
+}
+/**
+ * @class ConditionInfo
+ * @param options  {Object}
+ * @param options.message   {String|LocalizedText} the event message
+ * @param options.severity  {UInt16} severity
+ * @param options.quality   {StatusCode} quality
+ * @param options.retain   {Boolean} retain flag
+ * @constructor
+ */
+export declare class ConditionInfo {
+    message: LocalizedText | null;
+    quality: StatusCode | null;
+    severity: UInt16 | null;
+    retain: boolean | null;
+    constructor(options: ConditionInfoOptions);
+}

package/dist/src/alarms_and_conditions/condition_info.js

@@ -1,55 +1,55 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConditionInfo = void 0;
-/**
- * @module node-opcua-address-space.AlarmsAndConditions
- */
-const node_opcua_assert_1 = require("node-opcua-assert");
-const node_opcua_data_model_1 = require("node-opcua-data-model");
-/**
- * @class ConditionInfo
- * @param options  {Object}
- * @param options.message   {String|LocalizedText} the event message
- * @param options.severity  {UInt16} severity
- * @param options.quality   {StatusCode} quality
- * @param options.retain   {Boolean} retain flag
- * @constructor
- */
-class ConditionInfo {
-    constructor(options) {
-        this.message = null;
-        this.quality = null;
-        this.severity = 0;
-        this.retain = false;
-        this.severity = null;
-        this.quality = null;
-        this.message = null;
-        this.retain = null;
-        if (Object.prototype.hasOwnProperty.call(options, "message") && options.message) {
-            this.message = node_opcua_data_model_1.LocalizedText.coerce(options.message);
-        }
-        if (Object.prototype.hasOwnProperty.call(options, "quality") && options.quality !== null) {
-            this.quality = options.quality;
-        }
-        if (Object.prototype.hasOwnProperty.call(options, "severity") && options.severity !== null) {
-            (0, node_opcua_assert_1.assert)(typeof options.severity === "number");
-            this.severity = options.severity;
-        }
-        if (Object.prototype.hasOwnProperty.call(options, "retain") && options.retain !== null) {
-            (0, node_opcua_assert_1.assert)(typeof options.retain === "boolean");
-            this.retain = options.retain;
-        }
-    }
-    /**
-     * @method isDifferentFrom
-     * @param otherConditionInfo {ConditionInfo}
-     * @return {Boolean}
-     */
-    isDifferentFrom(otherConditionInfo) {
-        return (this.severity !== otherConditionInfo.severity ||
-            this.quality !== otherConditionInfo.quality ||
-            this.message !== otherConditionInfo.message);
-    }
-}
-exports.ConditionInfo = ConditionInfo;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConditionInfo = void 0;
+/**
+ * @module node-opcua-address-space.AlarmsAndConditions
+ */
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_data_model_1 = require("node-opcua-data-model");
+/**
+ * @class ConditionInfo
+ * @param options  {Object}
+ * @param options.message   {String|LocalizedText} the event message
+ * @param options.severity  {UInt16} severity
+ * @param options.quality   {StatusCode} quality
+ * @param options.retain   {Boolean} retain flag
+ * @constructor
+ */
+class ConditionInfo {
+    constructor(options) {
+        this.message = null;
+        this.quality = null;
+        this.severity = 0;
+        this.retain = false;
+        this.severity = null;
+        this.quality = null;
+        this.message = null;
+        this.retain = null;
+        if (Object.prototype.hasOwnProperty.call(options, "message") && options.message) {
+            this.message = node_opcua_data_model_1.LocalizedText.coerce(options.message);
+        }
+        if (Object.prototype.hasOwnProperty.call(options, "quality") && options.quality !== null) {
+            this.quality = options.quality;
+        }
+        if (Object.prototype.hasOwnProperty.call(options, "severity") && options.severity !== null) {
+            (0, node_opcua_assert_1.assert)(typeof options.severity === "number");
+            this.severity = options.severity;
+        }
+        if (Object.prototype.hasOwnProperty.call(options, "retain") && options.retain !== null) {
+            (0, node_opcua_assert_1.assert)(typeof options.retain === "boolean");
+            this.retain = options.retain;
+        }
+    }
+    /**
+     * @method isDifferentFrom
+     * @param otherConditionInfo {ConditionInfo}
+     * @return {Boolean}
+     */
+    isDifferentFrom(otherConditionInfo) {
+        return (this.severity !== otherConditionInfo.severity ||
+            this.quality !== otherConditionInfo.quality ||
+            this.message !== otherConditionInfo.message);
+    }
+}
+exports.ConditionInfo = ConditionInfo;
 //# sourceMappingURL=condition_info.js.map