node-opcua-address-space 2.51.0

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

@@ -0,0 +1,16 @@
+/**
+ * @module node-opcua-address-space.AlarmsAndConditions
+ */
+import { NodeId } from "node-opcua-nodeid";
+import { INamespace } from "../../source";
+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: any, data: any): UASystemOffNormalAlarmImpl;
+}

package/dist/src/alarms_and_conditions/ua_system_off_normal_alarm_impl.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ua_system_off_normal_alarm_impl.js","sourceRoot":"","sources":["../../../src/alarms_and_conditions/ua_system_off_normal_alarm_impl.ts"],"names":[],"mappings":";;;AAMA,yEAAkE;AAElE;;;;;;GAMG;AACH,MAAa,0BAA2B,SAAS,+CAAoB;IAE1D,MAAM,CAAC,WAAW,CACrB,SAAqB,EACrB,gBAAiC,EACjC,OAAY,EACZ,IAAS;QAEP,OAAO,+CAAoB,CAAC,WAAW,CACrC,SAAS,EAAE,gBAAgB,EAAE,OAAO,EAAE,IAAI,CAA+B,CAAC;IAClF,CAAC;CACJ;AAXD,gEAWC"}

package/dist/src/apply_condition_refresh.d.ts

@@ -0,0 +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;

package/dist/src/apply_condition_refresh.js

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

package/dist/src/apply_condition_refresh.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply_condition_refresh.js","sourceRoot":"","sources":["../../src/apply_condition_refresh.ts"],"names":[],"mappings":";;;AACA,iFAA4E;AAK5E,SAAgB,uBAAuB,CAAqB,MAA8B;IACtF,kCAAkC;IAClC,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;IACtB,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;IACtC,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;IAE5C,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IACrE,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;QAChC,IAAI,SAAS,YAAY,mCAAe,EAAE;YACtC,SAAS,CAAC,uBAAuB,EAAE,CAAC;SACvC;KACJ;IACD,MAAM,GAAG,GAAI,EAAqB,CAAC,MAAM,CAAC,SAA2B,EAAE,YAA8B,CAAC,CAAC;IAEvG,KAAK,MAAM,QAAQ,IAAI,GAAG,EAAE;QACxB,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QACvC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE;YACd,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;YACvB,IAAI,QAAQ,CAAC,iBAAiB,EAAE;gBAC5B,QAAQ,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;aACtC;SACJ;KACJ;AACL,CAAC;AAvBD,0DAuBC"}

package/dist/src/base_node.d.ts

@@ -0,0 +1,279 @@
+/// <reference types="node" />
+import { EventEmitter } from "events";
+import { AttributeIds, BrowseDirection, LocalizedText, LocalizedTextLike, NodeClass, QualifiedName, QualifiedNameLike, QualifiedNameOptions, AccessRestrictionsFlag } from "node-opcua-data-model";
+import { DataValue } from "node-opcua-data-value";
+import { NodeId, NodeIdLike } from "node-opcua-nodeid";
+import { NumericRange } from "node-opcua-numeric-range";
+import { ReferenceDescription } from "node-opcua-service-browse";
+import { StatusCode } from "node-opcua-status-code";
+import { BrowseDescription, RelativePathElement, RolePermissionType, RolePermissionTypeOptions } from "node-opcua-types";
+import { DataType } from "node-opcua-variant";
+import { AddReferenceOpts, BaseNode as BaseNodePublic, ModellingRuleType, Namespace, SessionContext, UAMethod as UAMethodPublic, UAObject as UAObjectPublic, UAObjectType as UAObjectTypePublic, UAReference, UAReference as UAReferencePublic, UAReferenceType as UAReferenceTypePublic, UAVariable as UAVariablePublic, UAVariableT, UAVariableType as UAVariableTypePublic, XmlWriter } from "../source";
+import { UAStateVariable } from "../source/interfaces/state_machine/ua_state_variable";
+import { AddressSpacePrivate } from "./address_space_private";
+import { Reference } from "./reference";
+export interface InternalBaseNodeOptions {
+    /**
+     * the parent address space
+     */
+    addressSpace: AddressSpacePrivate;
+    browseName: QualifiedName;
+    nodeId: NodeId;
+    references?: Reference[];
+    displayName?: LocalizedTextLike | LocalizedTextLike[];
+    description?: LocalizedTextLike | null;
+    browseFilter?: (this: BaseNode, context?: SessionContext) => boolean;
+    /**
+     * https://reference.opcfoundation.org/v104/Core/docs/Part3/8.56/
+     */
+    accessRestrictions?: AccessRestrictionsFlag;
+    rolePermissions?: RolePermissionTypeOptions[];
+}
+export interface BaseNode {
+    /**
+     * NodeVersion (Optional) String The NodeVersion Property is used to indicate the version of a Node.
+     * The NodeVersion Property is updated each time a Reference is added or deleted to the Node the Property
+     * belongs to. Attribute value changes do not cause the NodeVersion to change.
+     * Clients may read the NodeVersion Property or subscribe to it to determine when the structure of a Node has changed.
+     */
+    nodeVersion?: UAVariableT<string, DataType.String>;
+}
+export declare function makeAttributeEventName(attributeId: AttributeIds): string;
+/**
+ * Base class for all Node classes
+ *
+ * BaseNode is the base class for all the OPCUA objects in the address space
+ * It provides attributes and a set of references to other nodes.
+ * see:
+ * {{#crossLink "UAObject"}}{{/crossLink}},
+ * {{#crossLink "UAVariable"}}{{/crossLink}},
+ * {{#crossLink "Reference"}}{{/crossLink}},
+ * {{#crossLink "UAMethod"}}{{/crossLink}},
+ * {{#crossLink "UAView"}}{{/crossLink}},
+ * {{#crossLink "UAObjectType"}}{{/crossLink}},
+ * {{#crossLink "UADataType"}}{{/crossLink}},
+ * {{#crossLink "UAVariableType"}}{{/crossLink}},
+ *
+ *
+ */
+export declare class BaseNode extends EventEmitter implements BaseNodePublic {
+    accessRestrictions?: AccessRestrictionsFlag;
+    rolePermissions?: RolePermissionType[];
+    onFirstBrowseAction?: (this: BaseNodePublic) => Promise<void>;
+    get addressSpace(): AddressSpacePrivate;
+    get displayName(): LocalizedText[];
+    set displayName(value: LocalizedText[]);
+    get description(): LocalizedText;
+    set description(value: LocalizedText);
+    /**
+     * returns the nodeId of this node's Type Definition
+     */
+    get typeDefinition(): NodeId;
+    /**
+     * returns the nodeId of this node's Type Definition
+     */
+    get typeDefinitionObj(): UAObjectTypePublic | UAVariableTypePublic;
+    get parentNodeId(): NodeId | undefined;
+    /**
+     * namespace index
+     */
+    get namespaceIndex(): number;
+    /**
+     * namespace uri
+     */
+    get namespaceUri(): string;
+    /**
+     * the parent node
+     */
+    get parent(): BaseNodePublic | null;
+    /**
+     * @property modellingRule
+     * @type {String|undefined}
+     */
+    get modellingRule(): ModellingRuleType;
+    static makeAttributeEventName(attributeId: AttributeIds): string;
+    nodeClass: NodeClass;
+    readonly nodeId: NodeId;
+    readonly browseName: QualifiedName;
+    protected _postInstantiateFunc?: any;
+    /**
+     * @internal
+     * @param options
+     */
+    constructor(options: InternalBaseNodeOptions);
+    getDisplayName(locale?: string): string;
+    get namespace(): Namespace;
+    findReferencesEx(referenceType: string | NodeId | UAReferenceTypePublic, browseDirection?: BrowseDirection): UAReferencePublic[];
+    findReferences(referenceType: string | NodeId | UAReferenceTypePublic, isForward?: boolean): UAReferencePublic[];
+    findReference(strReference: string | NodeId | UAReferenceTypePublic, isForward?: boolean): UAReferencePublic | null;
+    findReferencesExAsObject(referenceType: string | NodeId | UAReferenceTypePublic, browseDirection?: BrowseDirection): BaseNode[];
+    findReferencesAsObject(referenceType: string | NodeId | UAReferenceTypePublic, isForward?: boolean): BaseNode[];
+    /**
+     * return an array with the Aggregates of this object.
+     */
+    getAggregates(): BaseNode[];
+    /**
+     * return an array with the components of this object.
+     */
+    getComponents(): BaseNode[];
+    /**
+     *  return a array with the properties of this object.
+     */
+    getProperties(): BaseNode[];
+    /**
+     * return a array with the notifiers of this object.
+     */
+    getNotifiers(): BaseNode[];
+    /**
+     * return a array with the event source of this object.
+     */
+    getEventSources(): BaseNode[];
+    /**
+     * return a array of the objects for which this node is an EventSource
+     */
+    getEventSourceOfs(): BaseNode[];
+    /**
+     * retrieve a component by name
+     */
+    getComponentByName(browseName: QualifiedNameOptions): UAVariablePublic | UAObjectPublic | null;
+    getComponentByName(browseName: string, namespaceIndex?: number): UAVariablePublic | UAObjectPublic | null;
+    /**
+     * retrieve a property by name
+     */
+    getPropertyByName(browseName: QualifiedNameOptions): UAVariablePublic | null;
+    getPropertyByName(browseName: string, namespaceIndex?: number): UAVariablePublic | null;
+    /**
+     * retrieve a folder element by name
+     */
+    getFolderElementByName(browseName: QualifiedNameOptions): BaseNode | null;
+    getFolderElementByName(browseName: string, namespaceIndex?: number): BaseNode | null;
+    /**
+     * returns the list of nodes that this folder object organizes
+     */
+    getFolderElements(): BaseNode[];
+    /**
+     * returns the list of methods that this object provides
+     * @method getMethods
+     * @return an array with Method objects.
+     *
+     *
+     * Note: internally, methods are special types of components
+     */
+    getMethods(): UAMethodPublic[];
+    /**
+     * returns the method exposed by this object and with the given nodeId
+     */
+    getMethodById(nodeId: NodeId): UAMethodPublic | null;
+    getMethodByName(browseName: QualifiedNameLike, namespaceIndex?: number): UAMethodPublic | null;
+    getWriteMask(): number;
+    getUserWriteMask(): number;
+    readAttribute(context: SessionContext | null, attributeId: AttributeIds, indexRange?: NumericRange, dataEncoding?: string): DataValue;
+    writeAttribute(context: SessionContext | null, writeValue: any, callback: (err: Error | null, statusCode?: StatusCode) => void): void;
+    fullName(): string;
+    ownReferences(): Reference[];
+    /**
+     * @method browseNodeByTargetName
+     *
+     * @param relativePathElement
+     * @param isLast
+     * @return {NodeId[]}
+     */
+    browseNodeByTargetName(relativePathElement: RelativePathElement, isLast: boolean): NodeId[];
+    /**
+     * browse the node to extract information requested in browseDescription
+     * @method browseNode
+     * @param browseDescription
+     * @param context
+     * @return an array with reference descriptions
+     */
+    browseNode(browseDescription: BrowseDescription, context?: SessionContext): ReferenceDescription[];
+    allReferences(): Reference[];
+    /**
+     * @method addReference
+     * @param reference
+     * @param reference.referenceType {String}
+     * @param [reference.isForward = true] {Boolean}
+     * @param reference.nodeId {Node|NodeId|String}
+     *
+     * @example
+     *
+     *     view.addReference({ referenceType: "Organizes", nodeId: myDevice });
+     *
+     * or
+     *
+     *     myDevice1.addReference({ referenceType: "OrganizedBy", nodeId: view });
+     */
+    addReference(reference: AddReferenceOpts): void;
+    removeReference(referenceOpts: AddReferenceOpts): void;
+    /**
+     *
+     */
+    resolveNodeId(nodeId: NodeIdLike): NodeId;
+    install_extra_properties(): void;
+    uninstall_extra_properties(reference: Reference): void;
+    toString(): string;
+    /**
+     * @property isFalseSubStateOf
+     * @type {BaseNode|null}
+     */
+    get isFalseSubStateOf(): BaseNodePublic | null;
+    /**
+     * @property isTrueSubStateOf
+     * @type {BaseNode|null}
+     */
+    get isTrueSubStateOf(): BaseNodePublic | null;
+    /**
+     * @method getFalseSubStates
+     * @return {UAStateVariable[]} return an array with the SubStates of this object.
+     */
+    getFalseSubStates(): UAStateVariable[];
+    /**
+     * @method getTrueSubStates
+     * @return {UAStateVariable[]} return an array with the SubStates of this object.
+     */
+    getTrueSubStates(): UAStateVariable[];
+    findHierarchicalReferences(): UAReference[];
+    getChildByName(browseName: QualifiedNameOptions): BaseNode | null;
+    getChildByName(browseName: string, namespaceIndex?: number): BaseNode | null;
+    get toStateNode(): BaseNode | null;
+    get fromStateNode(): BaseNode | null;
+    /**
+     * this methods propagates the forward references to the pointed node
+     * by inserting backward references to the counter part node
+     */
+    propagate_back_references(): void;
+    /**
+     * the dispose method should be called when the node is no longer used, to release
+     * back pointer to the address space and clear caches.
+     *
+     * @method dispose
+     *
+     */
+    dispose(): void;
+    dumpXML(xmlWriter: XmlWriter): void;
+    /**
+     * Undo the effect of propagate_back_references
+     */
+    unpropagate_back_references(): void;
+    installPostInstallFunc(f: any): void;
+    _on_child_added(): void;
+    _on_child_removed(obj: BaseNode): void;
+    protected _add_backward_reference(reference: Reference): void;
+    protected _coerceReferenceType(referenceType: string | NodeId | UAReferenceTypePublic): UAReferenceTypePublic | null;
+    private __addReference;
+    private _setDisplayName;
+    private _setDescription;
+    private _notifyAttributeChange;
+    private _clear_caches;
+    private _readAccessRestrictions;
+    private _readRolePermissions;
+    private _readUserRolePermissions;
+    /**
+     *
+     * @param rolePermissions
+     */
+    setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void;
+    getRolePermissions(inherited: boolean): RolePermissionType[] | null;
+    setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void;
+    getAccessRestrictions(inherited: boolean): AccessRestrictionsFlag;
+}