NodeOPCUA API Documentation
    Preparing search index...

    Interface UAConditionEx<T>
    namespace http://opcfoundation.org/UA/
    nodeClass ObjectType
    typedDefinition BaseEventType i=2041
    isAbstract true
    interface UAConditionEx<
        T extends UAConditionEvents & ListenerSignature<T> = UAConditionEvents,
    > {
        addComment: UAMethod;
        branchId: UAProperty<NodeId, NodeId>;
        browseName: QualifiedName;
        clientUserId: UAProperty<UAString, String>;
        comment: UAConditionVariable<LocalizedText, LocalizedText>;
        conditionClassId: UAProperty<NodeId, NodeId>;
        conditionClassName: UAProperty<LocalizedText, LocalizedText>;
        conditionName: UAProperty<UAString, String>;
        conditionRefresh: UAMethod;
        conditionRefresh2: UAMethod;
        conditionSubClassId?: UAProperty<NodeId[], NodeId>;
        conditionSubClassName?: UAProperty<LocalizedText[], LocalizedText>;
        disable: UAMethod;
        enable: UAMethod;
        enabledState: UATwoStateVariableEx;
        eventId: UAProperty<Buffer<ArrayBufferLike>, ByteString>;
        eventNotifier: EventNotifierFlags;
        eventType: UAProperty<NodeId, NodeId>;
        hasMethods: boolean;
        lastSeverity: UAConditionVariable<number, UInt16>;
        localTime?: UAProperty<DTTimeZone, ExtensionObject>;
        message: UAProperty<LocalizedText, LocalizedText>;
        nodeClass: Object;
        nodeId: NodeId;
        onFirstBrowseAction?: (this: BaseNode) => Promise<void>;
        quality: UAConditionVariable<StatusCode, StatusCode>;
        receiveTime: UAProperty<Date, DateTime>;
        retain: UAProperty<boolean, Boolean>;
        severity: UAProperty<number, UInt16>;
        sourceName: UAProperty<UAString, String>;
        sourceNode: UAProperty<NodeId, NodeId>;
        supportsFilteredRetain: UAProperty<boolean, Boolean>;
        time: UAProperty<Date, DateTime>;
        get accessRestrictions(): AccessRestrictionsFlag | undefined;
        get addressSpace(): IAddressSpace;
        get description(): LocalizedText;
        get displayName(): LocalizedText[];
        get modellingRule(): ModellingRuleType | undefined;
        get namespace(): INamespace;
        get namespaceIndex(): number;
        get namespaceUri(): string;
        get parent(): BaseNode<BaseNodeEvents> | null;
        get parentNodeId(): NodeId | undefined;
        get rolePermissions(): RolePermissionType[] | undefined;
        get typeDefinition(): NodeId;
        get typeDefinitionObj(): UAObjectType;
        addReference(options: AddReferenceOpts): void;
        allReferences(): UAReference[];
        browseNode(
            browseDescription: BrowseDescriptionOptions2,
            session?: ISessionContext,
        ): ReferenceDescription[];
        browseNodeByTargetName(
            relativePathElement: RelativePathElement,
            isLast: boolean,
        ): NodeId[];
        clone(
            options: CloneOptions,
            optionalFilter?: CloneFilter,
            extraInfo?: CloneExtraInfo,
        ): UAObject;
        conditionOfNode(): | UAObject<UAObjectEvents>
        | UAVariable<UAVariableEvents>
        | null;
        createBranch(): ConditionSnapshot;
        currentBranch(): ConditionSnapshot;
        deleteBranch(branch: ConditionSnapshot): void;
        emit<K extends string | number | symbol>(
            event: K,
            ...args: Parameters<T[K]>,
        ): boolean;
        findBranchForEventId(
            eventId: Buffer<ArrayBufferLike> | null,
        ): ConditionSnapshot | null;
        findReference(
            referenceType: string | NodeId | UAReferenceType,
            isForward?: boolean,
        ): UAReference | null;
        findReferences(
            referenceType: string | NodeId | UAReferenceType,
            isForward?: boolean,
        ): UAReference[];
        findReferencesAsObject(
            referenceType: string | NodeId | UAReferenceType,
            isForward?: boolean,
        ): BaseNode<BaseNodeEvents>[];
        findReferencesEx(
            referenceType: string | NodeId | UAReferenceType,
            browseDirection?: BrowseDirection,
        ): UAReference[];
        findReferencesExAsObject(
            referenceType: string | NodeId | UAReferenceType,
            browseDirection?: BrowseDirection,
        ): BaseNode<BaseNodeEvents>[];
        fullName(): string;
        getAccessRestrictions(inherited: boolean): AccessRestrictionsFlag;
        getAggregates(): BaseNode<BaseNodeEvents>[];
        getBranchCount(): number;
        getBranches(): ConditionSnapshot[];
        getBranchIds(): NodeId[];
        getChildByName(
            browseName: QualifiedNameOptions,
        ): BaseNode<BaseNodeEvents> | null;
        getChildByName(
            browseName: string,
            namespaceIndex?: number,
        ): BaseNode<BaseNodeEvents> | null;
        getComponentByName(
            componentName: QualifiedNameOptions,
        ): UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null;
        getComponentByName(
            componentName: string,
            namespaceIndex?: number,
        ): UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null;
        getComponents(): BaseNode<BaseNodeEvents>[];
        getDisplayName(locale?: string): string;
        getEnabledState(): boolean;
        getEnabledStateAsString(): string;
        getEventSourceOfs(): BaseNode<BaseNodeEvents>[];
        getEventSources(): BaseNode<BaseNodeEvents>[];
        getFolderElementByName(
            browseName: QualifiedNameOptions,
        ): BaseNode<BaseNodeEvents> | null;
        getFolderElementByName(
            browseName: string,
            namespaceIndex?: number,
        ): BaseNode<BaseNodeEvents> | null;
        getMethodById(nodeId: NodeId): UAMethod<UAMethodEvents> | null;
        getMethodByName(
            methodName: QualifiedNameOptions,
        ): UAMethod<UAMethodEvents> | null;
        getMethodByName(
            methodName: string,
            namespaceIndex?: number,
        ): UAMethod<UAMethodEvents> | null;
        getMethods(): UAMethod<UAMethodEvents>[];
        getNodeVersion(): UAProperty<UAString, String> | null;
        getNotifiers(): BaseNode<BaseNodeEvents>[];
        getProperties(): BaseNode<BaseNodeEvents>[];
        getPropertyByName(
            propertyName: QualifiedNameOptions,
        ): UAVariable<UAVariableEvents> | null;
        getPropertyByName(
            propertyName: string,
            namespaceIndex?: number,
        ): UAVariable<UAVariableEvents> | null;
        getRolePermissions(inherited: boolean): RolePermissionType[] | null;
        install_extra_properties(): void;
        isDisposed(): boolean;
        listenerCount<K extends string | number | symbol>(event: K): number;
        off<K extends string | number | symbol>(event: K, listener: T[K]): this;
        on<K extends string | number | symbol>(event: K, listener: T[K]): this;
        once<K extends string | number | symbol>(event: K, listener: T[K]): this;
        raiseConditionEvent(branch: ConditionSnapshot, renewEventId: boolean): void;
        raiseEvent(
            eventType: BaseNode<BaseNodeEvents> | EventTypeLike,
            eventData: RaiseEventData,
        ): void;
        raiseNewBranchState(branch: ConditionSnapshot): void;
        raiseNewCondition(conditionInfo: ConditionInfoOptions): void;
        readAttribute(
            context: ISessionContext | null,
            attributeId: AttributeIds,
            indexRange?: NumericRange,
            dataEncoding?: QualifiedNameLike | null,
        ): DataValue;
        removeAllListeners(): void;
        removeListener<K extends string | number | symbol>(
            event: K,
            listener: T[K],
        ): void;
        removeReference(referenceOpts: AddReferenceOpts): void;
        setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void;
        setDescription(value: LocalizedTextLike | null): void;
        setDisplayName(value: LocalizedTextLike | LocalizedTextLike[]): void;
        setEnabledState(
            requestedEnabledState: boolean,
            options?: ISetStateOptions,
        ): StatusCode;
        setEventNotifier(eventNotifierFlags: EventNotifierFlags): void;
        setLocalTime(time: TimeZoneDataType): void;
        setMaxListeners(n: number): void;
        setReceiveTime(time: Date): void;
        setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void;
        setSourceName(name: string): void;
        setSourceNode(node: NodeId | BaseNode<BaseNodeEvents>): void;
        setTime(time: Date): void;
        writeAttribute(
            context: ISessionContext | null,
            writeValue: WriteValueOptions,
            callback: (err: Error | null, statusCode?: StatusCode) => void,
        ): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    addComment branchId browseName clientUserId comment conditionClassId conditionClassName conditionName conditionRefresh conditionRefresh2 conditionSubClassId? conditionSubClassName? disable enable enabledState eventId eventNotifier eventType hasMethods lastSeverity localTime? message nodeClass nodeId onFirstBrowseAction? quality receiveTime retain severity sourceName sourceNode supportsFilteredRetain time

    Accessors

    accessRestrictions addressSpace description displayName modellingRule namespace namespaceIndex namespaceUri parent parentNodeId rolePermissions typeDefinition typeDefinitionObj

    Methods

    addReference allReferences browseNode browseNodeByTargetName clone conditionOfNode createBranch currentBranch deleteBranch emit findBranchForEventId findReference findReferences findReferencesAsObject findReferencesEx findReferencesExAsObject fullName getAccessRestrictions getAggregates getBranchCount getBranches getBranchIds getChildByName getComponentByName getComponents getDisplayName getEnabledState getEnabledStateAsString getEventSourceOfs getEventSources getFolderElementByName getMethodById getMethodByName getMethods getNodeVersion getNotifiers getProperties getPropertyByName getRolePermissions install_extra_properties isDisposed listenerCount off on once raiseConditionEvent raiseEvent raiseNewBranchState raiseNewCondition readAttribute removeAllListeners removeListener removeReference setAccessRestrictions setDescription setDisplayName setEnabledState setEventNotifier setLocalTime setMaxListeners setReceiveTime setRolePermissions setSourceName setSourceNode setTime writeAttribute

    Properties

    addComment: UAMethod
    branchId: UAProperty<NodeId, NodeId>
    browseName: QualifiedName
    clientUserId: UAProperty<UAString, String>
    comment: UAConditionVariable<LocalizedText, LocalizedText>
    conditionClassId: UAProperty<NodeId, NodeId>
    conditionClassName: UAProperty<LocalizedText, LocalizedText>
    conditionName: UAProperty<UAString, String>
    conditionRefresh: UAMethod
    conditionRefresh2: UAMethod
    conditionSubClassId?: UAProperty<NodeId[], NodeId>
    conditionSubClassName?: UAProperty<LocalizedText[], LocalizedText>
    disable: UAMethod
    enable: UAMethod
    enabledState: UATwoStateVariableEx
    eventId: UAProperty<Buffer<ArrayBufferLike>, ByteString>
    eventNotifier: EventNotifierFlags
    eventType: UAProperty<NodeId, NodeId>
    hasMethods: boolean
    lastSeverity: UAConditionVariable<number, UInt16>
    localTime?: UAProperty<DTTimeZone, ExtensionObject>
    message: UAProperty<LocalizedText, LocalizedText>
    nodeClass: Object
    nodeId: NodeId
    onFirstBrowseAction?: (this: BaseNode) => Promise<void>
    quality: UAConditionVariable<StatusCode, StatusCode>
    receiveTime: UAProperty<Date, DateTime>
    retain: UAProperty<boolean, Boolean>
    severity: UAProperty<number, UInt16>
    sourceName: UAProperty<UAString, String>
    sourceNode: UAProperty<NodeId, NodeId>
    supportsFilteredRetain: UAProperty<boolean, Boolean>
    time: UAProperty<Date, DateTime>

    Accessors

    • get addressSpace(): IAddressSpace

      Returns IAddressSpace

    • get description(): LocalizedText

      Returns LocalizedText

    • get displayName(): LocalizedText[]

      Returns LocalizedText[]

    • get modellingRule(): ModellingRuleType | undefined

      Returns ModellingRuleType | undefined

    • get namespace(): INamespace

      Returns INamespace

    • get namespaceIndex(): number

      Returns number

    • get namespaceUri(): string

      Returns string

    • get parentNodeId(): NodeId | undefined

      Returns NodeId | undefined

    • get rolePermissions(): RolePermissionType[] | undefined

      Returns RolePermissionType[] | undefined

    • get typeDefinition(): NodeId

      Returns NodeId

    • get typeDefinitionObj(): UAObjectType

      Returns UAObjectType

    Methods

    • Type Parameters

      • K extends string | number | symbol

      Parameters

      • event: K
      • ...args: Parameters<T[K]>

      Returns boolean

    • find the the references that are strictly of type reference.

      The isForward boolean flag specifies the direction of the references to be looked for.

      Forward direction is implied if omitted.

      • will throw an exception if more than one reference exists with the referenceType.
      • will return null if no reference exists.

      Parameters

      Returns UAReference | null

    • find all the references that are strictly of type reference. The isForward boolean flag specifies the direction of the references to be looked for.

      Forward direction is implied if omitted.

      Parameters

      Returns UAReference[]

    • find all the nodes that are referenced by references strictly of type reference.

      The isForward boolean flag specifies the direction of the references to be looked for.

      Forward direction is implied if omitted.

      • will throw an exception if more than one reference exists with the referenceType.
      • will return null if no reference exists.

      Parameters

      Returns BaseNode<BaseNodeEvents>[]

    • return a complete name of this object by pre-pending name of its parent(s) to its own name

      Returns string

    • get effective accessRestrictions if (inherited is true) and node has no accessRestrictions, then default accessRestriction from namespace is returned if (inherited is false) and node has no accessRestrictions, then AccessRestrictionsFlag.None is returned

      Parameters

      • inherited: boolean

      Returns AccessRestrictionsFlag

    • Parameters

      • Optionallocale: string

        the locale of the text to return (e.g. en-EN)

      Returns string

    • private

      Returns void

    • Returns boolean

    • Type Parameters

      • K extends string | number | symbol

      Parameters

      • event: K

      Returns number

    • Type Parameters

      • K extends string | number | symbol

      Parameters

      • event: K
      • listener: T[K]

      Returns this

    • Type Parameters

      • K extends string | number | symbol

      Parameters

      • event: K
      • listener: T[K]

      Returns this

    • Type Parameters

      • K extends string | number | symbol

      Parameters

      • event: K
      • listener: T[K]

      Returns this

    • Returns void

    • Type Parameters

      • K extends string | number | symbol

      Parameters

      • event: K
      • listener: T[K]

      Returns void

    • Parameters

      • n: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    addReferenceallReferencesbrowseNodebrowseNodeByTargetNamecloneconditionOfNodecreateBranchcurrentBranchdeleteBranchemitfindBranchForEventIdfindReferencefindReferencesfindReferencesAsObjectfindReferencesExfindReferencesExAsObjectfullNamegetAccessRestrictionsgetAggregatesgetBranchCountgetBranchesgetBranchIdsgetChildByNamegetComponentByNamegetComponentsgetDisplayNamegetEnabledStategetEnabledStateAsStringgetEventSourceOfsgetEventSourcesgetFolderElementByNamegetMethodByIdgetMethodByNamegetMethodsgetNodeVersiongetNotifiersgetPropertiesgetPropertyByNamegetRolePermissionsinstall_extra_propertiesisDisposedlistenerCountoffononceraiseConditionEventraiseEventraiseNewBranchStateraiseNewConditionreadAttributeremoveAllListenersremoveListenerremoveReferencesetAccessRestrictionssetDescriptionsetDisplayNamesetEnabledStatesetEventNotifiersetLocalTimesetMaxListenerssetReceiveTimesetRolePermissionssetSourceNamesetSourceNodesetTimewriteAttribute