node-opcua-address-space 2.51.0

package/dist/src/alarms_and_conditions/condition_info.js

@@ -0,0 +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;
+//# sourceMappingURL=condition_info.js.map

package/dist/src/alarms_and_conditions/condition_info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"condition_info.js","sourceRoot":"","sources":["../../../src/alarms_and_conditions/condition_info.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,yDAA2C;AAE3C,iEAAyE;AAWzE;;;;;;;;GAQG;AACH,MAAa,aAAa;IAMtB,YAAY,OAA6B;QALlC,YAAO,GAAyB,IAAI,CAAC;QACrC,YAAO,GAAsB,IAAI,CAAC;QAClC,aAAQ,GAAkB,CAAC,CAAC;QAC5B,WAAM,GAAmB,KAAK,CAAC;QAGlC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QAEnB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE;YAC7E,IAAI,CAAC,OAAO,GAAG,qCAAa,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SACxD;QACD,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,OAAO,CAAC,OAAO,KAAK,IAAI,EAAE;YACtF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAQ,CAAC;SACnC;QACD,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,EAAE;YACxF,IAAA,0BAAM,EAAC,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;YAC7C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAS,CAAC;SACrC;QACD,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE;YACpF,IAAA,0BAAM,EAAC,OAAO,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC;YAC5C,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAO,CAAC;SACjC;IACL,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,kBAAiC;QACpD,OAAO,CACH,IAAI,CAAC,QAAQ,KAAK,kBAAkB,CAAC,QAAQ;YAC7C,IAAI,CAAC,OAAO,KAAK,kBAAkB,CAAC,OAAO;YAC3C,IAAI,CAAC,OAAO,KAAK,kBAAkB,CAAC,OAAO,CAC9C,CAAC;IACN,CAAC;CACJ;AAxCD,sCAwCC"}

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

@@ -0,0 +1,232 @@
+/// <reference types="node" />
+/**
+ * @module node-opcua-address-space.AlarmsAndConditions
+ */
+import { EventEmitter } from "events";
+import { IEventData, UAVariable, BaseNode, ISessionContext } from "node-opcua-address-space-base";
+import { UInt16 } from "node-opcua-basic-types";
+import { LocalizedText, LocalizedTextLike } from "node-opcua-data-model";
+import { NodeId } from "node-opcua-nodeid";
+import { StatusCode } from "node-opcua-status-code";
+import { SimpleAttributeOperand, TimeZoneDataType } from "node-opcua-types";
+import { DataType, Variant } from "node-opcua-variant";
+import { UtcTime } from "../../source/interfaces/state_machine/ua_state_machine_type";
+export interface ConditionSnapshot {
+    on(eventName: "value_changed", eventHandler: (node: UAVariable, variant: Variant) => void): this;
+}
+declare function normalizeName(str: string): string;
+export declare class ConditionSnapshot extends EventEmitter {
+    static normalizeName: typeof normalizeName;
+    condition: BaseNode;
+    eventData: IEventData | null;
+    branchId: NodeId | null;
+    private _map;
+    private _node_index;
+    /**
+     * @class ConditionSnapshot
+     * @extends EventEmitter
+     * @param condition
+     * @param branchId
+     * @constructor
+     */
+    constructor(condition: BaseNode, branchId: NodeId);
+    _constructEventData(): IEventData;
+    /**
+     * @method resolveSelectClause
+     * @param selectClause {SelectClause}
+     */
+    resolveSelectClause(selectClause: SimpleAttributeOperand): NodeId | null;
+    /**
+     *
+     */
+    readValue(sessionContext: ISessionContext, nodeId: NodeId, selectClause: SimpleAttributeOperand): Variant;
+    _get_var(varName: string): any;
+    _set_var(varName: string, dataType: DataType, value: unknown): void;
+    /**
+     * @method getBrandId
+     * @return {NodeId}
+     */
+    getBranchId(): NodeId;
+    /**
+     * @method getEventId
+     * @return {ByteString}
+     */
+    getEventId(): Buffer;
+    /**
+     * @method getRetain
+     * @return {Boolean}
+     */
+    getRetain(): boolean;
+    /**
+     *
+     * @method setRetain
+     * @param retainFlag {Boolean}
+     */
+    setRetain(retainFlag: boolean): void;
+    /**
+     * @method renewEventId
+     *
+     */
+    renewEventId(): void;
+    /**
+     * @method getEnabledState
+     * @return {Boolean}
+     */
+    getEnabledState(): boolean;
+    /**
+     * @method setEnabledState
+     * @param value {Boolean}
+     * @return void
+     */
+    setEnabledState(value: boolean): void;
+    /**
+     * @method getEnabledStateAsString
+     * @return {String}
+     */
+    getEnabledStateAsString(): string;
+    /**
+     * @method getComment
+     * @return {LocalizedText}
+     */
+    getComment(): LocalizedText;
+    /**
+     * Set condition comment
+     *
+     * Comment contains the last comment provided for a certain state (ConditionBranch). It may
+     * have been provided by an AddComment Method, some other Method or in some other
+     * manner. The initial value of this Variable is null, unless it is provided in some other manner. If
+     * a Method provides as an option the ability to set a Comment, then the value of this Variable is
+     * reset to null if an optional comment is not provided.
+     *
+     * @method setComment
+     * @param txtMessage {LocalizedText}
+     */
+    setComment(txtMessage: LocalizedTextLike): void;
+    /**
+     *
+     * @method setMessage
+     * @param txtMessage {LocalizedText}
+     */
+    setMessage(txtMessage: LocalizedTextLike | LocalizedText): void;
+    /**
+     * @method setClientUserId
+     * @param userIdentity {String}
+     */
+    setClientUserId(userIdentity: string): void;
+    /**
+     * set the condition quality
+     * @method setQuality
+     * @param quality {StatusCode}
+     */
+    setQuality(quality: StatusCode): void;
+    /**
+     * @method getQuality
+     * @return {StatusCode}
+     */
+    getQuality(): StatusCode;
+    /**
+     * @method setSeverity
+     * @param severity {UInt16}
+     */
+    setSeverity(severity: UInt16): void;
+    /**
+     * @method getSeverity
+     * @return {UInt16}
+     */
+    getSeverity(): UInt16;
+    /**
+     * @method setLastSeverity
+     * @param severity {UInt16}
+     */
+    setLastSeverity(severity: UInt16): void;
+    /**
+     * @method getLastSeverity
+     * @return {UInt16}
+     */
+    getLastSeverity(): UInt16;
+    /**
+     * setReceiveTime
+     *
+     * (as per OPCUA 1.0.3 part 5)
+     *
+     * ReceiveTime provides the time the OPC UA Server received the Event from the underlying
+     * device of another Server.
+     *
+     * ReceiveTime is analogous to ServerTimestamp defined in Part 4, i.e.
+     * in the case where the OPC UA Server gets an Event from another OPC UA Server, each Server
+     * applies its own ReceiveTime. That implies that a Client may get the same Event, having the
+     * same EventId, from different Servers having different values of the ReceiveTime.
+     *
+     * The ReceiveTime shall always be returned as value and the Server is not allowed to return a
+     * StatusCode for the ReceiveTime indicating an error.
+     *
+     * @method setReceiveTime
+     * @param time {Date} : UTCTime
+     */
+    setReceiveTime(time: UtcTime): void;
+    /**
+     * (as per OPCUA 1.0.3 part 5)
+     * Time provides the time the Event occurred. This value is set as close to the event generator as
+     * possible. It often comes from the underlying system or device. Once set, intermediate OPC UA
+     * Servers shall not alter the value.
+     *
+     * @method setTime
+     * @param time {Date}
+     */
+    setTime(time: Date): void;
+    /**
+     * LocalTime is a structure containing the Offset and the DaylightSavingInOffset flag. The Offset
+     * specifies the time difference (in minutes) between the Time Property and the time at the location
+     * in which the event was issued. If DaylightSavingInOffset is TRUE, then Standard/Daylight
+     * savings time (DST) at the originating location is in effect and Offset includes the DST c orrection.
+     * If FALSE then the Offset does not include DST correction and DST may or may not have been
+     * in effect.
+     * @method setLocalTime
+     * @param localTime {TimeZone}
+     */
+    setLocalTime(localTime: TimeZoneDataType): void;
+    getSourceName(): LocalizedText;
+    /**
+     * @method getSourceNode
+     * return {NodeId}
+     */
+    getSourceNode(): NodeId;
+    /**
+     * @method getEventType
+     * return {NodeId}
+     */
+    getEventType(): NodeId;
+    getMessage(): LocalizedText;
+    isCurrentBranch(): boolean;
+    getAckedState(): boolean;
+    setAckedState(ackedState: boolean): StatusCode;
+    getConfirmedState(): boolean;
+    setConfirmedStateIfExists(confirmedState: boolean): void;
+    setConfirmedState(confirmedState: boolean): void;
+    /**
+     * @class ConditionSnapshot
+     */
+    /**
+     * @method getSuppressedState
+     * @return {Boolean}
+     */
+    getSuppressedState(): boolean;
+    /**
+     * @method setSuppressedState
+     * @param suppressed {Boolean}
+     */
+    setSuppressedState(suppressed: boolean): void;
+    getActiveState(): boolean;
+    setActiveState(newActiveState: boolean): StatusCode;
+    setShelvingState(): void;
+    toString(): string;
+    /**
+     * @class ConditionSnapshot
+     * @param varName
+     * @param value
+     * @private
+     */
+    _set_twoStateVariable(varName: string, value: boolean): void;
+    protected _get_twoStateVariable(varName: string): any;
+}
+export {};