Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StateMachine

  subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Properties

Methods

Properties

Readonly addressSpace

addressSpace: AddressSpace

Readonly browseName

browseName: QualifiedName

Readonly currentState

currentState: StateVariable

Current state CurrentState stores the current state of an instance of the StateMachineType. CurrentState provides a human readable name for the current state which may not be suitable for use in application control logic. Applications should use the Id Property of CurrentState if they need a nique identifier for the state.

Readonly description

description: LocalizedText

Readonly displayName

displayName: LocalizedText[]

Readonly hasMethods

hasMethods: boolean

Readonly initialState

initialState: InitialState

Optional Readonly lastTransition

lastTransition: TransitionVariable

Last transition

LastTransition stores the last transition which occurred in an instance of the StateMachineType. LastTransition provides a human readable name.

Optional Readonly modellingRule

modellingRule: ModellingRuleType

Readonly namespace

namespace: Namespace

Readonly namespaceIndex

namespaceIndex: number

Readonly namespaceUri

namespaceUri: string

Readonly nodeClass

nodeClass: Object

Readonly nodeId

nodeId: NodeId

Optional onFirstBrowseAction

onFirstBrowseAction: () => Promise<void>

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

parent

parent: BaseNode

Optional Readonly parentNodeId

parentNodeId: NodeId

Readonly states

states: State[]

Readonly transitions

transitions: Transition[]

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAObjectType

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): StateMachine

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StateMachine

addReference

allReferences

browseNode

clone

  • clone(options: any, optionalFilter?: any, extraInfo?: any): UAObject

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

findReference

  • findReference(strReference: string, isForward?: boolean): UAReference

findReferences

findReferencesAsObject

  • findReferencesAsObject(strReference: string, isForward: boolean): BaseNode[]

findReferencesEx

findReferencesExAsObject

findTransitionNode

fullName

  • fullName(): string

getAggregates

getChildByName

getComponentByName

getComponents

getCurrentState

  • getCurrentState(): string

  • Returns string

getEventSourceOfs

getEventSources

getFolderElementByName

  • getFolderElementByName(browseName: string, namespaceIndex?: number): BaseNode

getMaxListeners

  • getMaxListeners(): number

getMethodById

getMethodByName

  • getMethodByName(methodName: string): UAMethod

getMethods

getNotifiers

getProperties

getPropertyByName

  • getPropertyByName(browseName: string, namespaceIndex?: number): UAVariable

getStateByName

  • getStateByName(name: string): State

  • Parameters

    • name: string

    Returns State

getStates

  • Returns State[]

getTransitions

install_extra_properties

  • install_extra_properties(): void

isValidTransition

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): StateMachine

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StateMachine

on

once

  • once(event: string | symbol, listener: (...args: any[]) => void): StateMachine

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StateMachine

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): StateMachine

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StateMachine

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): StateMachine

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StateMachine

propagate_back_references

  • propagate_back_references(): void

raiseEvent

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

readAttribute

removeAllListeners

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): StateMachine

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StateMachine

removeReference

setMaxListeners

setState

  • Parameters

    Returns void

writeAttribute

  • writeAttribute(context: SessionContext, writeValue: any, callback: (err: Error, statusCode?: StatusCode) => void): void

Generated using TypeDoc