Options
All
  • Public
  • Public/Protected
  • All
Menu

  subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Properties

Readonly addressSpace

addressSpace: AddressSpace

Readonly browseName

browseName: QualifiedName

currentState

currentState: FiniteStateVariable

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.

currentStateNode

currentStateNode: State

Readonly description

description: LocalizedText

Readonly displayName

displayName: LocalizedText[]

Readonly halt

halt: UAMethod

Halt Causes the Program to transition from the Ready, Running or Suspended state to the Halted state.

Readonly halted

halted: State

Readonly haltedToReady

haltedToReady: Transition

Readonly hasMethods

hasMethods: boolean

Readonly initialState

initialState: InitialState

Readonly isAbstract

isAbstract: boolean

Optional lastTransition

lastTransition: FiniteTransitionVariable

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: ObjectType

Readonly nodeId

nodeId: NodeId

Optional onFirstBrowseAction

onFirstBrowseAction: () => Promise<void>

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

Optional Readonly parentNodeId

parentNodeId: NodeId

Readonly ready

ready: State

Readonly readyToHalted

readyToHalted: Transition

Readonly readyToRunning

readyToRunning: Transition

reset

reset: UAMethod

Reset Causes the Program to transition from the Halted state to the Ready state

Readonly resume

resume: UAMethod

Resume Causes the Program to transition from the Suspended state to the Running state.

Readonly running

running: State

Readonly runningToHalted

runningToHalted: Transition

Readonly runningToReady

runningToReady: Transition

Readonly runningToSuspended

runningToSuspended: Transition

Readonly start

start: UAMethod

Start Causes the Program to transition from the Ready state to the Running state.

Readonly states

states: State[]

Readonly subtypeOf

subtypeOf: NodeId

Readonly subtypeOfObj

subtypeOfObj: UAObjectType

Readonly suspend

suspend: UAMethod

Suspend Causes the Program to transition from the Running state to the Suspended state.

Readonly suspended

suspended: State

Readonly suspendedToHalted

suspendedToHalted: Transition

Readonly suspendedToReady

suspendedToReady: Transition

Readonly suspendedToRunning

suspendedToRunning: Transition

Readonly transitions

transitions: Transition[]

Methods

addListener

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns ProgramFiniteStateMachineType

addReference

allReferences

browseNode

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
  • return the current state as string

    Returns string

getEventSourceOfs

getEventSources

getMaxListeners

  • getMaxListeners(): number

getMethodById

getMethodByName

  • getMethodByName(methodName: string): UAMethod

getMethods

getNotifiers

getProperties

getPropertyByName

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

getStateByName

  • getStateByName(name: string): State
  • return the state Node by Name

    Parameters

    • name: string

    Returns State

getStates

  • return all state nodes associated with this state machine

    Returns State[]

getTransitions

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

    Returns Transition[]

install_extra_properties

  • install_extra_properties(): void

instantiate

isSupertypeOf

isValidTransition

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

    Parameters

    Returns boolean

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

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns ProgramFiniteStateMachineType

on

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns ProgramFiniteStateMachineType

once

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns ProgramFiniteStateMachineType

prependListener

prependOnceListener

propagate_back_references

  • propagate_back_references(): void

rawListeners

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

    • event: string | symbol

    Returns Function[]

readAttribute

removeAllListeners

removeListener

removeReference

setMaxListeners

setState

  • change the current state

    note:

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

    Parameters

    Returns void

writeAttribute

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

Generated using TypeDoc