NodeOPCUA API Documentation
    Preparing search index...

    Interface UAShelvedStateMachineEx

    UAObject

    interface UAShelvedStateMachineEx {
        _currentStateNode: UAState | null;
        _duration: number;
        _shelvedTime: Date;
        _timer: Timeout | null;
        _unshelvedTime: Date;
        availableStates?: UABaseDataVariable<NodeId[], NodeId>;
        availableTransitions?: UABaseDataVariable<NodeId[], NodeId>;
        browseName: QualifiedName;
        currentState: UAStateVariable<LocalizedText>;
        currentStateNode: UAState | null;
        eventNotifier: EventNotifierFlags;
        hasMethods: boolean;
        initialState: UAInitialState | null;
        lastTransition?: UATransitionVariable<LocalizedText>;
        nodeClass: Object;
        nodeId: NodeId;
        oneShotShelve: UAMethod;
        oneShotShelve2?: UAMethod<UAMethodEvents>;
        oneShotShelved: UAState;
        oneShotShelvedToTimedShelved: UATransitionEx;
        oneShotShelvedToUnshelved: UATransitionEx;
        onFirstBrowseAction?: (this: BaseNode) => Promise<void>;
        states: UAState[];
        timedShelve: UAMethod;
        timedShelve2?: UAMethod<UAMethodEvents>;
        timedShelved: UAState;
        timedShelvedToOneShotShelved: UATransitionEx;
        timedShelvedToUnshelved: UATransitionEx;
        transitions: UATransitionEx[];
        unshelve: UAMethod;
        unshelve2?: UAMethod<UAMethodEvents>;
        unshelved: UAState;
        unshelvedToOneShotShelved: UATransitionEx;
        unshelvedToTimedShelved: UATransitionEx;
        unshelveTime: UAProperty<number, Double>;
        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;
        emit<K extends keyof UAObjectEvents>(
            event: K,
            ...args: Parameters<UAObjectEvents[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>[];
        findTransitionNode(
            fromStateNode: UAState,
            toStateNode: UAState,
            predicate?: TransitionSelector,
        ): UATransitionEx | null;
        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>[];
        getCurrentState(): string | null;
        getDisplayName(locale?: string): 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;
        getStateByName(name: string): UAState | null;
        getStates(): UAState[];
        getTransitions(): UATransitionEx[];
        install_extra_properties(): void;
        isDisposed(): boolean;
        isValidTransition(
            toStateNode: string | UAState,
            predicate?: TransitionSelector,
        ): boolean;
        listenerCount<K extends keyof UAObjectEvents>(event: K): number;
        off<K extends keyof UAObjectEvents>(
            event: K,
            listener: UAObjectEvents[K],
        ): this;
        on<K extends keyof UAObjectEvents>(
            event: K,
            listener: UAObjectEvents[K],
        ): this;
        once<K extends keyof UAObjectEvents>(
            event: K,
            listener: UAObjectEvents[K],
        ): this;
        raiseEvent(
            eventType: BaseNode<BaseNodeEvents> | EventTypeLike,
            eventData: RaiseEventData,
        ): void;
        readAttribute(
            context: ISessionContext | null,
            attributeId: AttributeIds,
            indexRange?: NumericRange,
            dataEncoding?: QualifiedNameLike | null,
        ): DataValue;
        removeAllListeners(): void;
        removeListener<K extends keyof UAObjectEvents>(
            event: K,
            listener: UAObjectEvents[K],
        ): void;
        removeReference(referenceOpts: AddReferenceOpts): void;
        setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void;
        setDescription(value: LocalizedTextLike | null): void;
        setDisplayName(value: LocalizedTextLike | LocalizedTextLike[]): void;
        setEventNotifier(eventNotifierFlags: EventNotifierFlags): void;
        setMaxListeners(n: number): void;
        setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void;
        setState(
            toStateNode: string | UAState | null,
            predicate?: TransitionSelector,
        ): void;
        writeAttribute(
            context: ISessionContext | null,
            writeValue: WriteValueOptions,
            callback: (err: Error | null, statusCode?: StatusCode) => void,
        ): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _currentStateNode _duration _shelvedTime _timer _unshelvedTime availableStates? availableTransitions? browseName currentState currentStateNode eventNotifier hasMethods initialState lastTransition? nodeClass nodeId oneShotShelve oneShotShelve2? oneShotShelved oneShotShelvedToTimedShelved oneShotShelvedToUnshelved onFirstBrowseAction? states timedShelve timedShelve2? timedShelved timedShelvedToOneShotShelved timedShelvedToUnshelved transitions unshelve unshelve2? unshelved unshelvedToOneShotShelved unshelvedToTimedShelved unshelveTime

    Accessors

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

    Methods

    addReference allReferences browseNode browseNodeByTargetName clone emit findReference findReferences findReferencesAsObject findReferencesEx findReferencesExAsObject findTransitionNode fullName getAccessRestrictions getAggregates getChildByName getComponentByName getComponents getCurrentState getDisplayName getEventSourceOfs getEventSources getFolderElementByName getMethodById getMethodByName getMethods getNodeVersion getNotifiers getProperties getPropertyByName getRolePermissions getStateByName getStates getTransitions install_extra_properties isDisposed isValidTransition listenerCount off on once raiseEvent readAttribute removeAllListeners removeListener removeReference setAccessRestrictions setDescription setDisplayName setEventNotifier setMaxListeners setRolePermissions setState writeAttribute

    Properties

    _currentStateNode

    _currentStateNode: UAState | null

    _duration

    _duration: number

    _shelvedTime

    _shelvedTime: Date

    _timer

    _timer: Timeout | null

    _unshelvedTime

    _unshelvedTime: Date
    availableStates?: UABaseDataVariable<NodeId[], NodeId>
    availableTransitions?: UABaseDataVariable<NodeId[], NodeId>
    browseName: QualifiedName
    currentState: UAStateVariable<LocalizedText>
    currentStateNode: UAState | null
    eventNotifier: EventNotifierFlags
    hasMethods: boolean
    initialState: UAInitialState | null
    lastTransition?: UATransitionVariable<LocalizedText>
    nodeClass: Object
    nodeId: NodeId
    oneShotShelve: UAMethod
    oneShotShelve2?: UAMethod<UAMethodEvents>
    oneShotShelved: UAState
    oneShotShelvedToTimedShelved: UATransitionEx
    oneShotShelvedToUnshelved: UATransitionEx
    onFirstBrowseAction?: (this: BaseNode) => Promise<void>
    states: UAState[]
    timedShelve: UAMethod
    timedShelve2?: UAMethod<UAMethodEvents>
    timedShelved: UAState
    timedShelvedToOneShotShelved: UATransitionEx
    timedShelvedToUnshelved: UATransitionEx
    transitions: UATransitionEx[]
    unshelve: UAMethod
    unshelve2?: UAMethod<UAMethodEvents>
    unshelved: UAState
    unshelvedToOneShotShelved: UATransitionEx
    unshelvedToTimedShelved: UATransitionEx
    unshelveTime: UAProperty<number, Double>

    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

    • get typeDefinition(): NodeId

      Returns NodeId

    • get typeDefinitionObj(): UAObjectType

      Returns UAObjectType

    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

    • return the current state as string

      Returns string | null

    • Parameters

      • Optionallocale: string

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

      Returns string

    • return the state Node by Name

      Parameters

      • name: string

      Returns UAState | null

    • return all state nodes associated with this state machine

      Returns UAState[]

    • return all state to state transition node associated with this state machine

      Returns UATransitionEx[]

    • Returns boolean

    • returns true if there is a valid transition from currentStateNode to toStateNode

      Parameters

      Returns boolean

    • Parameters

      • n: number

      Returns void

    • change the current state

      note:

      • a transition from currentState to toState node must exists
      • a TransitionEventType event will be raised

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods