NodeOPCUA API Documentation
    Preparing search index...

    Interface BaseNode<T>

    interface BaseNode<
        T extends BaseNodeEvents & ListenerSignature<T> = BaseNodeEvents,
    > {
        browseName: QualifiedName;
        nodeClass: NodeClass;
        nodeId: NodeId;
        onFirstBrowseAction?: (this: BaseNode) => Promise<void>;
        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 parentNodeId(): NodeId | undefined;
        get rolePermissions(): RolePermissionType[] | undefined;
        addReference(options: AddReferenceOpts): void;
        allReferences(): UAReference[];
        browseNode(
            browseDescription: BrowseDescriptionOptions2,
            session?: ISessionContext,
        ): ReferenceDescription[];
        browseNodeByTargetName(
            relativePathElement: RelativePathElement,
            isLast: boolean,
        ): NodeId[];
        emit<K extends string | number | symbol>(
            event: K,
            ...args: Parameters<T[K]>,
        ): boolean;
        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>[];
        getChildByName(
            browseName: QualifiedNameOptions,
        ): BaseNode<BaseNodeEvents> | null;
        getChildByName(
            browseName: string,
            namespaceIndex?: number,
        ): BaseNode<BaseNodeEvents> | null;
        getDisplayName(locale?: string): string;
        getEventSourceOfs(): BaseNode<BaseNodeEvents>[];
        getEventSources(): BaseNode<BaseNodeEvents>[];
        getNodeVersion(): UAProperty<UAString, String> | 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;
        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;
        setMaxListeners(n: number): void;
        setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void;
        writeAttribute(
            context: ISessionContext | null,
            writeValue: WriteValueOptions,
            callback: (err: Error | null, statusCode?: StatusCode) => void,
        ): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    browseName nodeClass nodeId onFirstBrowseAction?

    Accessors

    accessRestrictions addressSpace description displayName modellingRule namespace namespaceIndex namespaceUri parentNodeId rolePermissions

    Methods

    addReference allReferences browseNode browseNodeByTargetName emit findReference findReferences findReferencesAsObject findReferencesEx findReferencesExAsObject fullName getAccessRestrictions getAggregates getChildByName getDisplayName getEventSourceOfs getEventSources getNodeVersion getRolePermissions install_extra_properties isDisposed listenerCount off on once readAttribute removeAllListeners removeListener removeReference setAccessRestrictions setDescription setDisplayName setMaxListeners setRolePermissions writeAttribute

    Properties

    browseName: QualifiedName
    nodeClass: NodeClass
    nodeId: NodeId
    onFirstBrowseAction?: (this: BaseNode) => Promise<void>

    Accessors

    • get namespace(): INamespace

      Returns INamespace

    • get namespaceIndex(): number

      Returns number

    • get namespaceUri(): string

      Returns string

    • get parentNodeId(): NodeId | undefined

      Returns NodeId | undefined

    Methods

    • Parameters

      Returns void

    • Returns UAReference[]

    • Parameters

      Returns NodeId[]

    • 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>[]

    • find all the references that are of type reference or a sub type of reference, in the direction specified by browseDirection

      • BrowseDirection.Forward direction is implied if browseDirection flags is omitted.

      Parameters

      Returns UAReference[]

    • find all the nodes that are referenced by references of type reference or a sub type of reference, in the direction specified by browseDirection

      • BrowseDirection.Forward direction is implied if browseDirection flags is omitted.

      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

    • Get the Child by name, if browseName is string and namespaceIndex undefined then the search doesn't care about namespace matching

      Parameters

      Returns BaseNode<BaseNodeEvents> | null

    • Parameters

      • browseName: string
      • OptionalnamespaceIndex: number

      Returns BaseNode<BaseNodeEvents> | null

    • Parameters

      • Optionallocale: string

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

      Returns string

    • return a array of the objects for which this node is an EventSource nodes = HasEventSource => self

      Returns BaseNode<BaseNodeEvents>[]

    • return a array with the event source of this object. self = HasEventSource => nodes

      Returns BaseNode<BaseNodeEvents>[]

    • Parameters

      • inherited: boolean

      Returns RolePermissionType[] | null

    • 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

    • Type Parameters

      • K extends string | number | symbol

      Parameters

      • event: K
      • listener: T[K]

      Returns void

    • Parameters

      Returns void

    • setAccessRestriction

      Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • n: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods