ProgramFiniteStateMachine | NodeOPCUA reference documentation

Hierarchy

ProgramFiniteStateMachineB
UAObject
- ProgramFiniteStateMachine

Index

Properties

Methods

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

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: 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 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 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[]

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAObjectType

Methods

addListener

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

Inherited from UAObject.addListener
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ProgramFiniteStateMachine

addReference

addReference(options: AddReferenceOpts): void

Inherited from UAObject.addReference
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:158
Parameters
- options: AddReferenceOpts
Returns void

allReferences

allReferences(): Reference[]

Inherited from UAObject.allReferences
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:199
Returns Reference[]

browseNode

browseNode(browseDescription: BrowseDescriptionOptions, session?: SessionContext): ReferenceDescription[]

Inherited from UAObject.browseNode
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:220
browse the node to extract information requested in browseDescription

method

browseNode

Parameters
- browseDescription: BrowseDescriptionOptions
- Optional session: SessionContext
Returns ReferenceDescription[]

clone

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

Inherited from UAObject.clone
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:788
Parameters
- options: any
- Optional optionalFilter: any
- Optional extraInfo: any
Returns UAObject

emit

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

Inherited from UAObject.emit
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from UAObject.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

findReference

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

Inherited from UAObject.findReference
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:193
Parameters
- strReference: string
- Optional isForward: boolean
Returns UAReference

findReferences

findReferences(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): UAReference[]

Inherited from UAObject.findReferences
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:191
Parameters
- referenceType: string | NodeId | UAReferenceType
- Optional isForward: boolean
Returns UAReference[]

findReferencesAsObject

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

Inherited from UAObject.findReferencesAsObject
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:197
Parameters
- strReference: string
- isForward: boolean
Returns BaseNode[]

findReferencesEx

findReferencesEx(strReference: string, browseDirection?: BrowseDirection): UAReference[]

Inherited from UAObject.findReferencesEx
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:189
Parameters
- strReference: string
- Optional browseDirection: BrowseDirection
Returns UAReference[]

findReferencesExAsObject

findReferencesExAsObject(strReference: string, browseDirection?: BrowseDirection): BaseNode[]

Inherited from UAObject.findReferencesExAsObject
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:195
Parameters
- strReference: string
- Optional browseDirection: BrowseDirection
Returns BaseNode[]

findTransitionNode

findTransitionNode(fromStateNode: State, toStateNode: State, predicate?: TransitionSelector): Transition

Inherited from ProgramFiniteStateMachineB.findTransitionNode
- Defined in packages/node-opcua-address-space/dist/source/interfaces/state_machine/state_machine.d.ts:308
try to find the valid transition between fromState Node to toState Node

Parameters
- fromStateNode: State
- toStateNode: State
- Optional predicate: TransitionSelector
Returns Transition

fullName

fullName(): string

Inherited from UAObject.fullName
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:156
return a complete name of this object by pre-pending name of its parent(s) to its own name

Returns string

getAggregates

getAggregates(): BaseNode[]

Inherited from UAObject.getAggregates
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:281
Returns BaseNode[]

getChildByName

getChildByName(browseName: string | QualifiedName): BaseNode

Inherited from UAObject.getChildByName
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:201
Parameters
- browseName: string | QualifiedName
Returns BaseNode

getComponentByName

getComponentByName(componentName: QualifiedNameLike, namespaceIndex?: number): UAObject | UAVariable

Inherited from UAObject.getComponentByName
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:277
Parameters
- componentName: QualifiedNameLike
- Optional namespaceIndex: number
Returns UAObject | UAVariable

getComponents

getComponents(): BaseNode[]

Inherited from UAObject.getComponents
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:283
Returns BaseNode[]

getCurrentState

getCurrentState(): string

Inherited from ProgramFiniteStateMachineB.getCurrentState
- Defined in packages/node-opcua-address-space/dist/source/interfaces/state_machine/state_machine.d.ts:312
return the current state as string

Returns string

getEventSourceOfs

getEventSourceOfs(): BaseNode[]

Inherited from UAObject.getEventSourceOfs
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:185
return a array of the objects for which this node is an EventSource nodes = HasEventSource => self

Returns BaseNode[]

getEventSources

getEventSources(): BaseNode[]

Inherited from UAObject.getEventSources
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:179
return a array with the event source of this object. self = HasEventSource => nodes

Returns BaseNode[]

getFolderElementByName

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

Inherited from UAObject.getFolderElementByName
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:775
Parameters
- browseName: string
- Optional namespaceIndex: number
Returns BaseNode

getMaxListeners

getMaxListeners(): number

Inherited from UAObject.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

getMethodById

getMethodById(nodeId: NodeId): UAMethod

Inherited from UAObject.getMethodById
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:778
Parameters
- nodeId: NodeId
Returns UAMethod

getMethodByName

getMethodByName(methodName: string): UAMethod

Inherited from UAObject.getMethodByName
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:780
Parameters
- methodName: string
Returns UAMethod

getMethods

getMethods(): UAMethod[]

Inherited from UAObject.getMethods
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:782
Returns UAMethod[]

getNotifiers

getNotifiers(): BaseNode[]

Inherited from UAObject.getNotifiers
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:287
Returns BaseNode[]

getProperties

getProperties(): BaseNode[]

Inherited from UAObject.getProperties
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:285
Returns BaseNode[]

getPropertyByName

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

Inherited from UAObject.getPropertyByName
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:279
Parameters
- browseName: string
- Optional namespaceIndex: number
Returns UAVariable

getStateByName

getStateByName(name: string): State

Inherited from ProgramFiniteStateMachineB.getStateByName
- Defined in packages/node-opcua-address-space/dist/source/interfaces/state_machine/state_machine.d.ts:297
return the state Node by Name

Parameters
- name: string
Returns State

getStates

getStates(): State[]

Inherited from ProgramFiniteStateMachineB.getStates
- Defined in packages/node-opcua-address-space/dist/source/interfaces/state_machine/state_machine.d.ts:288
return all state nodes associated with this state machine

Returns State[]

getTransitions

getTransitions(): Transition[]

Inherited from ProgramFiniteStateMachineB.getTransitions
- Defined in packages/node-opcua-address-space/dist/source/interfaces/state_machine/state_machine.d.ts:292
return all state to state transition node associated with this state machine

Returns Transition[]

install_extra_properties

install_extra_properties(): void

Inherited from UAObject.install_extra_properties
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:187
Returns void

isValidTransition

isValidTransition(toStateNode: string | State, predicate?: TransitionSelector): boolean

Inherited from ProgramFiniteStateMachineB.isValidTransition
- Defined in packages/node-opcua-address-space/dist/source/interfaces/state_machine/state_machine.d.ts:302
returns true if there is a valid transition from currentStateNode to toStateNode

Parameters
- toStateNode: string | State
- Optional predicate: TransitionSelector
Returns boolean

listenerCount

listenerCount(event: string | symbol): number

Inherited from UAObject.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

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

Inherited from UAObject.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

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

Inherited from UAObject.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ProgramFiniteStateMachine

on

on(eventName: "event", eventHandler: (eventData: IEventData) => void): ProgramFiniteStateMachine

Inherited from UAObject.on
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:786
Parameters
- eventName: "event"
- eventHandler: (eventData: IEventData) => void
  - - (eventData: IEventData): void
    - Parameters
      - eventData: IEventData
      Returns void
Returns ProgramFiniteStateMachine

once

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

Inherited from UAObject.once
- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ProgramFiniteStateMachine

prependListener

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

Inherited from UAObject.prependListener
- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ProgramFiniteStateMachine

prependOnceListener

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

Inherited from UAObject.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ProgramFiniteStateMachine

propagate_back_references

propagate_back_references(): void

Inherited from UAObject.propagate_back_references
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:207
this methods propagates the forward references to the pointed node by inserting backward references to the counter part node

Returns void

raiseEvent

raiseEvent(eventType: EventTypeLike, eventData: RaiseEventData): void

Inherited from UAObject.raiseEvent
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:784
Parameters
- eventType: EventTypeLike
- eventData: RaiseEventData
Returns void

rawListeners

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

Inherited from UAObject.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

readAttribute

readAttribute(context: SessionContext, attributeId: AttributeIds, indexRange?: NumericRange, dataEncoding?: QualifiedNameLike): DataValue

Inherited from UAObject.readAttribute
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:162
Parameters
- context: SessionContext
- attributeId: AttributeIds
- Optional indexRange: NumericRange
- Optional dataEncoding: QualifiedNameLike
Returns DataValue

removeAllListeners

removeAllListeners(event?: string | symbol): ProgramFiniteStateMachine

Inherited from UAObject.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns ProgramFiniteStateMachine

removeListener

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

Inherited from UAObject.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ProgramFiniteStateMachine

removeReference

removeReference(referenceOpts: AddReferenceOpts): void

Inherited from UAObject.removeReference
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:160
Parameters
- referenceOpts: AddReferenceOpts
Returns void

setMaxListeners

setMaxListeners(n: number): ProgramFiniteStateMachine

Inherited from UAObject.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns ProgramFiniteStateMachine

setState

setState(toStateNode: string | State, predicate?: TransitionSelector): void

Inherited from ProgramFiniteStateMachineB.setState
- Defined in packages/node-opcua-address-space/dist/source/interfaces/state_machine/state_machine.d.ts:321
change the current state

note:
- a transition from currentState to toState node must exists
- a TransitionEventType event will be raised
Parameters
- toStateNode: string | State
- Optional predicate: TransitionSelector
Returns void

writeAttribute

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

Inherited from UAObject.writeAttribute
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:169
Parameters
- context: SessionContext
- writeValue: any
- callback: (err: Error, statusCode?: StatusCode) => void
  - - (err: Error, statusCode?: StatusCode): void
    - Parameters
      - err: Error
      - Optional statusCode: StatusCode
      Returns void
Returns void

subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Properties

Methods

Properties

Readonly addressSpace

Readonly browseName

currentState

currentStateNode

Readonly description

Readonly displayName

Readonly halt

Readonly halted

Readonly haltedToReady

Readonly hasMethods

Readonly initialState

Optional lastTransition

Optional Readonly modellingRule

Readonly namespace

Readonly namespaceIndex

Readonly namespaceUri

Readonly nodeClass

Readonly nodeId

Optional onFirstBrowseAction

Type declaration

Returns Promise<void>

parent

Optional Readonly parentNodeId

Readonly ready

Readonly readyToHalted

Readonly readyToRunning

reset

Readonly resume

Readonly running

Readonly runningToHalted

Readonly runningToReady

Readonly runningToSuspended

Readonly start

Readonly states

Readonly suspend

Readonly suspended

Readonly suspendedToHalted

Readonly suspendedToReady

Readonly suspendedToRunning

Readonly transitions

typeDefinition

typeDefinitionObj

Methods

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns ProgramFiniteStateMachine

addReference

Parameters

options: AddReferenceOpts

Returns void

allReferences

Returns Reference[]

browseNode

Parameters

browseDescription: BrowseDescriptionOptions

Optional session: SessionContext

Returns ReferenceDescription[]

clone

Parameters

options: any

Optional optionalFilter: any

Optional extraInfo: any

Returns UAObject

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames