NodeOPCUA API Documentation
    Preparing search index...

    Interface HasSubStateMachine

    The HasSubStateMachine ReferenceType is a concrete ReferenceType and can be used directly. It is a subtype of NonHierarchicalReferences.

    The semantic of this ReferenceType is to point from a State to an instance of StateMachineType which represents the sub-states for the State.

    The SourceNode of this ReferenceType shall be an Object of the ObjectType StateType.

    The TargetNode shall be an Object of the ObjectType StateMachineType or one of its subtypes.

    Each Object can be the TargetNode of at most one HasSubStateMachine Reference.

    The SourceNode (the state) and the TargetNode (the SubStateMachine) shall belong to the same StateMachine, that is, both shall be referenced from the same Object of type StateMachineType using a HasComponent Reference or a subtype of HasComponent.

    interface HasSubStateMachine {
        browseName: QualifiedName;
        inverseName: LocalizedText;
        isAbstract: boolean;
        nodeClass: ReferenceType;
        nodeId: NodeId;
        onFirstBrowseAction?: (this: BaseNode) => Promise<void>;
        subtypeOf: NodeId | null;
        subtypeOfObj: UAReferenceType | 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[];
        checkHasSubtype(referenceType: NodeId | UAReference): boolean;
        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>[];
        getAllSubtypes(): UAReferenceType[];
        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;
        isSubtypeOf(baseType: NodeIdLike | UAReferenceType): boolean;
        isSupertypeOf(baseType: NodeIdLike | UAReferenceType): 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

    browseName inverseName isAbstract nodeClass nodeId onFirstBrowseAction? subtypeOf subtypeOfObj

    Accessors

    accessRestrictions addressSpace description displayName modellingRule namespace namespaceIndex namespaceUri parentNodeId rolePermissions

    Methods

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

    Properties

    browseName: QualifiedName
    inverseName: LocalizedText
    isAbstract: boolean
    nodeClass: ReferenceType
    nodeId: NodeId
    onFirstBrowseAction?: (this: BaseNode) => Promise<void>
    subtypeOf: NodeId | null
    subtypeOfObj: UAReferenceType | null

    Accessors

    • get accessRestrictions(): AccessRestrictionsFlag | undefined

      Returns AccessRestrictionsFlag | undefined

    • 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

    • Parameters

      • Optionallocale: string

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

      Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods