NodeOPCUA API Documentation
    Preparing search index...

    Interface UADataType

    interface UADataType {
        basicDataType: DataType;
        binaryEncoding: BaseNode<BaseNodeEvents> | null;
        binaryEncodingDefinition: string | null;
        binaryEncodingNodeId: ExpandedNodeId | null;
        browseName: QualifiedName;
        isAbstract: boolean;
        jsonEncoding: BaseNode<BaseNodeEvents> | null;
        jsonEncodingNodeId: ExpandedNodeId | null;
        nodeClass: DataType;
        nodeId: NodeId;
        onFirstBrowseAction?: (this: BaseNode) => Promise<void>;
        subtypeOf: NodeId | null;
        subtypeOfObj: UADataType | null;
        symbolicName: string;
        xmlEncoding: BaseNode<BaseNodeEvents> | null;
        xmlEncodingDefinition: string | null;
        xmlEncodingNodeId: ExpandedNodeId | null;
        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 keyof BaseNodeEvents>(
            event: K,
            ...args: Parameters<BaseNodeEvents[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>[];
        getBasicDataType(): DataType;
        getChildByName(
            browseName: QualifiedNameOptions,
        ): BaseNode<BaseNodeEvents> | null;
        getChildByName(
            browseName: string,
            namespaceIndex?: number,
        ): BaseNode<BaseNodeEvents> | null;
        getDefinition(): DataTypeDefinition;
        getDisplayName(locale?: string): string;
        getEncodingNode(encodingName: string): BaseNode<BaseNodeEvents> | null;
        getEnumDefinition(): EnumDefinition;
        getEventSourceOfs(): BaseNode<BaseNodeEvents>[];
        getEventSources(): BaseNode<BaseNodeEvents>[];
        getNodeVersion(): UAProperty<UAString, String> | null;
        getRolePermissions(inherited: boolean): RolePermissionType[] | null;
        getStructureDefinition(): StructureDefinition;
        install_extra_properties(): void;
        isDisposed(): boolean;
        isEnumeration(): boolean;
        isStructure(): boolean;
        isSubtypeOf(referenceType: NodeIdLike | UADataType): boolean;
        isSupertypeOf(referenceType: NodeIdLike | UADataType): boolean;
        listenerCount<K extends keyof BaseNodeEvents>(event: K): number;
        off<K extends keyof BaseNodeEvents>(
            event: K,
            listener: BaseNodeEvents[K],
        ): this;
        on<K extends keyof BaseNodeEvents>(
            event: K,
            listener: BaseNodeEvents[K],
        ): this;
        once<K extends keyof BaseNodeEvents>(
            event: K,
            listener: BaseNodeEvents[K],
        ): this;
        readAttribute(
            context: ISessionContext | null,
            attributeId: AttributeIds,
            indexRange?: NumericRange,
            dataEncoding?: QualifiedNameLike | null,
        ): DataValue;
        removeAllListeners(): void;
        removeListener<K extends keyof BaseNodeEvents>(
            event: K,
            listener: BaseNodeEvents[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;
    }

    Hierarchy (View Summary)

    Index

    Properties

    basicDataType binaryEncoding binaryEncodingDefinition binaryEncodingNodeId browseName isAbstract jsonEncoding jsonEncodingNodeId nodeClass nodeId onFirstBrowseAction? subtypeOf subtypeOfObj symbolicName xmlEncoding xmlEncodingDefinition xmlEncodingNodeId

    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 getBasicDataType getChildByName getDefinition getDisplayName getEncodingNode getEnumDefinition getEventSourceOfs getEventSources getNodeVersion getRolePermissions getStructureDefinition install_extra_properties isDisposed isEnumeration isStructure isSubtypeOf isSupertypeOf listenerCount off on once readAttribute removeAllListeners removeListener removeReference setAccessRestrictions setDescription setDisplayName setMaxListeners setRolePermissions writeAttribute

    Properties

    basicDataType: DataType
    binaryEncoding: BaseNode<BaseNodeEvents> | null
    binaryEncodingDefinition: string | null
    binaryEncodingNodeId: ExpandedNodeId | null
    browseName: QualifiedName
    isAbstract: boolean
    jsonEncoding: BaseNode<BaseNodeEvents> | null
    jsonEncodingNodeId: ExpandedNodeId | null
    nodeClass: DataType
    nodeId: NodeId
    onFirstBrowseAction?: (this: BaseNode) => Promise<void>
    subtypeOf: NodeId | null
    subtypeOfObj: UADataType | null
    symbolicName: string
    xmlEncoding: BaseNode<BaseNodeEvents> | null
    xmlEncodingDefinition: string | null
    xmlEncodingNodeId: ExpandedNodeId | null

    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

    Methods

    • 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

    • Returns DataType

    • Parameters

      • Optionallocale: string

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

      Returns string

    • Returns EnumDefinition

    • Returns StructureDefinition

    • private

      Returns void

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Parameters

      Returns boolean

      • use isSubtypeOf instead

    • Returns void

    • Parameters

      • n: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods