NodeOPCUA API Documentation
    Preparing search index...

    Interface UAProgramStateMachineType
    namespace http://opcfoundation.org/UA/
    nodeClass ObjectType
    typedDefinition ProgramStateMachineType i=2391
    isAbstract false
    interface UAProgramStateMachineType {
        autoDelete: UAProperty<boolean, Boolean>;
        availableStates?: UABaseDataVariable<NodeId[], NodeId>;
        availableTransitions?: UABaseDataVariable<NodeId[], NodeId>;
        browseName: QualifiedName;
        creatable: UAProperty<boolean, Boolean>;
        currentState: UAProgramStateMachine_currentState<LocalizedText>;
        deletable: UAProperty<boolean, Boolean>;
        finalResultData?: UAObject<UAObjectEvents>;
        halted: UAState;
        haltedToReady: UATransition;
        hasMethods: boolean;
        instanceCount: UAProperty<number, UInt32>;
        isAbstract: boolean;
        lastTransition: UAProgramStateMachine_lastTransition<LocalizedText>;
        maxInstanceCount: UAProperty<number, UInt32>;
        maxRecycleCount: UAProperty<number, UInt32>;
        nodeClass: ObjectType;
        nodeId: NodeId;
        onFirstBrowseAction?: (this: BaseNode) => Promise<void>;
        programDiagnostic?: UAProgramDiagnostic2<DTProgramDiagnostic2>;
        ready: UAState;
        readyToHalted: UATransition;
        readyToRunning: UATransition;
        recycleCount: UAProperty<number, Int32>;
        running: UAState;
        runningToHalted: UATransition;
        runningToReady: UATransition;
        runningToSuspended: UATransition;
        subtypeOf: NodeId | null;
        subtypeOfObj: UAObjectType | null;
        suspended: UAState;
        suspendedToHalted: UATransition;
        suspendedToReady: UATransition;
        suspendedToRunning: UATransition;
        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>[];
        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;
        getEventSourceOfs(): BaseNode<BaseNodeEvents>[];
        getEventSources(): BaseNode<BaseNodeEvents>[];
        getMethodById(nodeId: NodeId): UAMethod<UAMethodEvents> | null;
        getMethodByName(
            methodName: QualifiedNameOptions,
        ): UAMethod<UAMethodEvents> | null;
        getMethodByName(
            methodName: string,
            namespaceIndex?: number,
        ): UAMethod<UAMethodEvents> | null;
        getMethodByName(
            methodName: QualifiedNameLike,
            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;
        instantiate(options: InstantiateObjectOptions): UAProgramStateMachineEx;
        isDisposed(): boolean;
        isSubtypeOf(referenceType: NodeIdLike | UAObjectType): boolean;
        isSupertypeOf(referenceType: NodeIdLike | UAObjectType): 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

    autoDelete availableStates? availableTransitions? browseName creatable currentState deletable finalResultData? halted haltedToReady hasMethods instanceCount isAbstract lastTransition maxInstanceCount maxRecycleCount nodeClass nodeId onFirstBrowseAction? programDiagnostic? ready readyToHalted readyToRunning recycleCount running runningToHalted runningToReady runningToSuspended subtypeOf subtypeOfObj suspended suspendedToHalted suspendedToReady suspendedToRunning

    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 getComponentByName getComponents getDisplayName getEventSourceOfs getEventSources getMethodById getMethodByName getMethods getNodeVersion getNotifiers getProperties getPropertyByName getRolePermissions install_extra_properties instantiate isDisposed isSubtypeOf isSupertypeOf listenerCount off on once readAttribute removeAllListeners removeListener removeReference setAccessRestrictions setDescription setDisplayName setMaxListeners setRolePermissions writeAttribute

    Properties

    autoDelete: UAProperty<boolean, Boolean>
    availableStates?: UABaseDataVariable<NodeId[], NodeId>
    availableTransitions?: UABaseDataVariable<NodeId[], NodeId>
    browseName: QualifiedName
    creatable: UAProperty<boolean, Boolean>
    currentState: UAProgramStateMachine_currentState<LocalizedText>
    deletable: UAProperty<boolean, Boolean>
    finalResultData?: UAObject<UAObjectEvents>
    halted: UAState
    haltedToReady: UATransition
    hasMethods: boolean
    instanceCount: UAProperty<number, UInt32>
    isAbstract: boolean
    lastTransition: UAProgramStateMachine_lastTransition<LocalizedText>
    maxInstanceCount: UAProperty<number, UInt32>
    maxRecycleCount: UAProperty<number, UInt32>
    nodeClass: ObjectType
    nodeId: NodeId
    onFirstBrowseAction?: (this: BaseNode) => Promise<void>
    programDiagnostic?: UAProgramDiagnostic2<DTProgramDiagnostic2>
    ready: UAState
    readyToHalted: UATransition
    readyToRunning: UATransition
    recycleCount: UAProperty<number, Int32>
    running: UAState
    runningToHalted: UATransition
    runningToReady: UATransition
    runningToSuspended: UATransition
    subtypeOf: NodeId | null
    subtypeOfObj: UAObjectType | null
    suspended: UAState
    suspendedToHalted: UATransition
    suspendedToReady: UATransition
    suspendedToRunning: UATransition

    Accessors

    • get namespaceIndex(): number

      Returns number

    • get namespaceUri(): string

      Returns string

    • get parentNodeId(): NodeId | undefined

      Returns NodeId | 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

    • Returns boolean

    • Returns void

    • Parameters

      • n: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods