node-opcua-address-space 2.71.0 → 2.72.2

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

@@ -1,182 +1,187 @@
-/// <reference types="node" />
-import { ByteString } 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 { TimeZoneDataType } from "node-opcua-types";
-import { VariantLike } from "node-opcua-variant";
-import { UAVariable, INamespace, ISessionContext, UAEventType, UAObject } from "node-opcua-address-space-base";
-import { UACondition_Base } from "node-opcua-nodeset-ua";
-import { ConditionInfoOptions } from "../../source/interfaces/alarms_and_conditions/condition_info_i";
-import { AddressSpacePrivate } from "../address_space_private";
-import { UATwoStateVariableEx } from "../../source/ua_two_state_variable_ex";
-import { UABaseEventHelper, UABaseEventImpl } from "./ua_base_event_impl";
-import { ConditionSnapshot } from "./condition_snapshot";
-export declare type AddCommentEventHandler = (eventId: Buffer | null, comment: LocalizedText, branch: ConditionSnapshot) => void;
-export interface UAConditionHelper {
-    on(eventName: string, eventHandler: (...args: any[]) => void): this;
-    on(eventName: "addComment", eventHandler: AddCommentEventHandler): this;
-    on(eventName: "branch_deleted", eventHandler: (branchId: string) => void): this;
-}
-export interface UAConditionHelper extends UABaseEventHelper {
-    getBranchCount(): number;
-    getBranches(): ConditionSnapshot[];
-    getBranchIds(): NodeId[];
-    createBranch(): ConditionSnapshot;
-    deleteBranch(branch: ConditionSnapshot): void;
-    getEnabledState(): boolean;
-    getEnabledStateAsString(): string;
-    setEnabledState(requestedEnabledState: boolean): StatusCode;
-    setReceiveTime(time: Date): void;
-    setLocalTime(time: TimeZoneDataType): void;
-    setTime(time: Date): void;
-    conditionOfNode(): UAObject | UAVariable | null;
-    raiseConditionEvent(branch: ConditionSnapshot, renewEventId: boolean): void;
-    raiseNewCondition(conditionInfo: ConditionInfoOptions): void;
-    raiseNewBranchState(branch: ConditionSnapshot): void;
-    currentBranch(): ConditionSnapshot;
-}
-export interface UAConditionEx extends UAObject, UACondition_Base, UAConditionHelper {
-    enabledState: UATwoStateVariableEx;
-    on(eventName: string, eventHandler: any): this;
-}
-export declare interface UAConditionImpl extends UAConditionEx, UABaseEventImpl {
-    on(eventName: string, eventHandler: any): this;
-}
-/**
- *
- *   └─ ConditionType
- *    ├─ DialogConditionType
- *    └─ AcknowledgeableConditionType
- *       └─ AlarmConditionType
- *          ├─ LimitAlarmType
- *          │  ├─ ExclusiveLimitAlarmType
- *          │  │  ├─ ExclusiveLevelAlarmType
- *          │  │  ├─ ExclusiveDeviationAlarmType
- *          │  │  └─ ExclusiveRateOfChangeAlarmType
- *          │  └─ NonExclusiveLimitAlarmType
- *          │     ├─ NonExclusiveLevelAlarmType
- *          │     ├─ NonExclusiveDeviationAlarmType
- *          │     └─ NonExclusiveRateOfChangeAlarmType
- *          └─ DiscreteAlarmType
- *             ├─ OffNormalAlarmType
- *             │  ├─ SystemOffNormalAlarmType
- *             │  │  └─ CertificateExpirationAlarmType
- *             │  └─ TripAlarmType
- *
- */
-export declare class UAConditionImpl extends UABaseEventImpl implements UAConditionEx {
-    static defaultSeverity: number;
-    static typeDefinition: NodeId;
-    static instantiate(namespace: INamespace, conditionTypeId: NodeId | string | UAEventType, options: any, data: any): UAConditionImpl;
-    static install_condition_refresh_handle(addressSpace: AddressSpacePrivate): void;
-    /**
-     *
-     * Helper method to handle condition methods that takes a branchId and a comment
-     *
-     */
-    static with_condition_method(inputArguments: VariantLike[], context: ISessionContext, callback: (err: Error | null, result?: {
-        statusCode: StatusCode;
-    }) => void, inner_func: (eventId: ByteString, comment: LocalizedText, branch: ConditionSnapshot, conditionNode: UAConditionImpl) => StatusCode): void;
-    private _branch0;
-    private _previousRetainFlag;
-    private _branches;
-    /**
-     * @method initialize
-     * @private
-     */
-    initialize(): void;
-    /**
-     * @method post_initialize
-     * @private
-     */
-    post_initialize(): void;
-    getBranchCount(): number;
-    getBranches(): ConditionSnapshot[];
-    getBranchIds(): NodeId[];
-    /**
-     * @method createBranch
-     * @return {ConditionSnapshot}
-     */
-    createBranch(): ConditionSnapshot;
-    /**
-     *  @method deleteBranch
-     *  @param branch {ConditionSnapshot}
-     */
-    deleteBranch(branch: ConditionSnapshot): void;
-    /**
-     * @method getEnabledState
-     * @return {Boolean}
-     */
-    getEnabledState(): boolean;
-    /**
-     * @method getEnabledStateAsString
-     * @return {String}
-     */
-    getEnabledStateAsString(): string;
-    /**
-     * returns {StatusCode} StatusCodes.Good if successful or BadConditionAlreadyEnabled/BadConditionAlreadyDisabled
-     * @private
-     */
-    _setEnabledState(requestedEnabledState: boolean): StatusCode;
-    /**
-     *
-     * @method setEnabledState
-     * @param requestedEnabledState {Boolean}
-     * @private
-     */
-    setEnabledState(requestedEnabledState: boolean): StatusCode;
-    /**
-     * @method setReceiveTime
-     * @param time {Date}
-     */
-    setReceiveTime(time: Date): void;
-    /**
-     * @method setLocalTime (optional)
-     * @param time
-     */
-    setLocalTime(time: TimeZoneDataType): void;
-    /**
-     * @method setTime
-     * @param time {Date}
-     */
-    setTime(time: Date): void;
-    _assert_valid(): void;
-    /**
-     * @method conditionOfNode
-     * @return {UAObject}
-     */
-    conditionOfNode(): UAObject | UAVariable | null;
-    /**
-     * @method raiseConditionEvent
-     * Raise a Instance Event
-     * (see also UAObject#raiseEvent to raise a transient event)
-     * @param branch the condition branch to raise
-     * @param renewEventId true if event Id of the condition branch should be renewed
-     */
-    raiseConditionEvent(branch: ConditionSnapshot, renewEventId: boolean): void;
-    /**
-     *
-     * @method raiseNewCondition
-     * @param conditionInfo {ConditionInfo}
-     *
-     */
-    raiseNewCondition(conditionInfo: ConditionInfoOptions): void;
-    raiseNewBranchState(branch: ConditionSnapshot): void;
-    /**
-     * @method currentBranch
-     * @return {ConditionSnapshot}
-     */
-    currentBranch(): ConditionSnapshot;
-    _resend_conditionEvents(): 0 | 1;
-    /**
-     * @method _raiseAuditConditionCommentEvent
-     * @param sourceName {string}
-     * @param conditionEventId    {Buffer}
-     * @param comment    {LocalizedText}
-     * @private
-     */
-    _raiseAuditConditionCommentEvent(sourceName: string, conditionEventId: Buffer, comment: LocalizedTextLike): void;
-    protected _findBranchForEventId(eventId: Buffer): ConditionSnapshot | null;
-    protected evaluateConditionsAfterEnabled(): void;
-}
+/// <reference types="node" />
+import { ByteString } 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 { TimeZoneDataType } from "node-opcua-types";
+import { VariantLike } from "node-opcua-variant";
+import { UAVariable, INamespace, ISessionContext, UAEventType, BaseNode, UAObject, InstantiateObjectOptions } from "node-opcua-address-space-base";
+import { UACondition_Base } from "node-opcua-nodeset-ua";
+import { ConditionInfoOptions } from "../../source/interfaces/alarms_and_conditions/condition_info_i";
+import { UATwoStateVariableEx } from "../../source/ua_two_state_variable_ex";
+import { AddressSpacePrivate } from "../address_space_private";
+import { UABaseEventHelper, UABaseEventImpl } from "./ua_base_event_impl";
+import { ConditionSnapshot } from "./condition_snapshot";
+export declare type AddCommentEventHandler = (eventId: Buffer | null, comment: LocalizedText, branch: ConditionSnapshot) => void;
+export interface UAConditionHelper {
+    on(eventName: string, eventHandler: (...args: any[]) => void): this;
+    on(eventName: "addComment", eventHandler: AddCommentEventHandler): this;
+    on(eventName: "branch_deleted", eventHandler: (branchId: string) => void): this;
+}
+export interface UAConditionHelper extends UABaseEventHelper {
+    getBranchCount(): number;
+    getBranches(): ConditionSnapshot[];
+    getBranchIds(): NodeId[];
+    createBranch(): ConditionSnapshot;
+    deleteBranch(branch: ConditionSnapshot): void;
+    getEnabledState(): boolean;
+    getEnabledStateAsString(): string;
+    setEnabledState(requestedEnabledState: boolean): StatusCode;
+    setReceiveTime(time: Date): void;
+    setLocalTime(time: TimeZoneDataType): void;
+    setTime(time: Date): void;
+    conditionOfNode(): UAObject | UAVariable | null;
+    raiseConditionEvent(branch: ConditionSnapshot, renewEventId: boolean): void;
+    raiseNewCondition(conditionInfo: ConditionInfoOptions): void;
+    raiseNewBranchState(branch: ConditionSnapshot): void;
+    currentBranch(): ConditionSnapshot;
+}
+export interface UAConditionEx extends UAObject, UACondition_Base, UAConditionHelper {
+    enabledState: UATwoStateVariableEx;
+    on(eventName: string, eventHandler: any): this;
+}
+export declare interface UAConditionImpl extends UAConditionEx, UABaseEventImpl {
+    on(eventName: string, eventHandler: any): this;
+}
+/**
+ *
+ *   └─ ConditionType
+ *    ├─ DialogConditionType
+ *    └─ AcknowledgeableConditionType
+ *       └─ AlarmConditionType
+ *          ├─ LimitAlarmType
+ *          │  ├─ ExclusiveLimitAlarmType
+ *          │  │  ├─ ExclusiveLevelAlarmType
+ *          │  │  ├─ ExclusiveDeviationAlarmType
+ *          │  │  └─ ExclusiveRateOfChangeAlarmType
+ *          │  └─ NonExclusiveLimitAlarmType
+ *          │     ├─ NonExclusiveLevelAlarmType
+ *          │     ├─ NonExclusiveDeviationAlarmType
+ *          │     └─ NonExclusiveRateOfChangeAlarmType
+ *          └─ DiscreteAlarmType
+ *             ├─ OffNormalAlarmType
+ *             │  ├─ SystemOffNormalAlarmType
+ *             │  │  └─ CertificateExpirationAlarmType
+ *             │  └─ TripAlarmType
+ *
+ */
+export declare class UAConditionImpl extends UABaseEventImpl implements UAConditionEx {
+    static defaultSeverity: number;
+    static typeDefinition: NodeId;
+    static instantiate(namespace: INamespace, conditionTypeId: NodeId | string | UAEventType, options: any, data: any): UAConditionImpl;
+    static install_condition_refresh_handle(addressSpace: AddressSpacePrivate): void;
+    /**
+     *
+     * Helper method to handle condition methods that takes a branchId and a comment
+     *
+     */
+    static with_condition_method(inputArguments: VariantLike[], context: ISessionContext, callback: (err: Error | null, result?: {
+        statusCode: StatusCode;
+    }) => void, inner_func: (eventId: ByteString, comment: LocalizedText, branch: ConditionSnapshot, conditionNode: UAConditionImpl) => StatusCode): void;
+    private _branch0;
+    private _previousRetainFlag;
+    private _branches;
+    /**
+     * @method initialize
+     * @private
+     */
+    initialize(): void;
+    /**
+     * @method post_initialize
+     * @private
+     */
+    post_initialize(): void;
+    getBranchCount(): number;
+    getBranches(): ConditionSnapshot[];
+    getBranchIds(): NodeId[];
+    /**
+     * @method createBranch
+     * @return {ConditionSnapshot}
+     */
+    createBranch(): ConditionSnapshot;
+    /**
+     *  @method deleteBranch
+     *  @param branch {ConditionSnapshot}
+     */
+    deleteBranch(branch: ConditionSnapshot): void;
+    /**
+     * @method getEnabledState
+     * @return {Boolean}
+     */
+    getEnabledState(): boolean;
+    /**
+     * @method getEnabledStateAsString
+     * @return {String}
+     */
+    getEnabledStateAsString(): string;
+    /**
+     * returns {StatusCode} StatusCodes.Good if successful or BadConditionAlreadyEnabled/BadConditionAlreadyDisabled
+     * @private
+     */
+    _setEnabledState(requestedEnabledState: boolean): StatusCode;
+    /**
+     *
+     * @method setEnabledState
+     * @param requestedEnabledState {Boolean}
+     * @private
+     */
+    setEnabledState(requestedEnabledState: boolean): StatusCode;
+    /**
+     * @method setReceiveTime
+     * @param time {Date}
+     */
+    setReceiveTime(time: Date): void;
+    /**
+     * @method setLocalTime (optional)
+     * @param time
+     */
+    setLocalTime(time: TimeZoneDataType): void;
+    /**
+     * @method setTime
+     * @param time {Date}
+     */
+    setTime(time: Date): void;
+    _assert_valid(): void;
+    /**
+     * @method conditionOfNode
+     * @return {UAObject}
+     */
+    conditionOfNode(): UAObject | UAVariable | null;
+    /**
+     * @method raiseConditionEvent
+     * Raise a Instance Event
+     * (see also UAObject#raiseEvent to raise a transient event)
+     * @param branch the condition branch to raise
+     * @param renewEventId true if event Id of the condition branch should be renewed
+     */
+    raiseConditionEvent(branch: ConditionSnapshot, renewEventId: boolean): void;
+    /**
+     *
+     * @method raiseNewCondition
+     * @param conditionInfo {ConditionInfo}
+     *
+     */
+    raiseNewCondition(conditionInfo: ConditionInfoOptions): void;
+    raiseNewBranchState(branch: ConditionSnapshot): void;
+    /**
+     * @method currentBranch
+     * @return {ConditionSnapshot}
+     */
+    currentBranch(): ConditionSnapshot;
+    _resend_conditionEvents(): 0 | 1;
+    /**
+     * @method _raiseAuditConditionCommentEvent
+     * @param sourceName {string}
+     * @param conditionEventId    {Buffer}
+     * @param comment    {LocalizedText}
+     * @private
+     */
+    _raiseAuditConditionCommentEvent(sourceName: string, conditionEventId: Buffer, comment: LocalizedTextLike): void;
+    protected _findBranchForEventId(eventId: Buffer): ConditionSnapshot | null;
+    protected evaluateConditionsAfterEnabled(): void;
+}
+export interface InstantiateConditionOptions extends InstantiateObjectOptions {
+    conditionOf?: UAObject | BaseNode | NodeId | null;
+    conditionClass?: UAObject | BaseNode | NodeId | null;
+    conditionName?: string;
+}