Class StateMachine

Hierarchy

UAObject
StateMachineB
UAObject
- StateMachine
  - ExclusiveLimitStateMachine
  - FiniteStateMachine

Implements

UAObject
StateMachine

Constructors

constructor

Accessors

currentStateNode

Methods

Constructors

constructor

new StateMachine(options: any): StateMachine

Inherited from UAAcknowledgeableConditionBase.constructor
- Defined in packages/node-opcua-address-space/src/ua_object.ts:34
Parameters
- options: any
Returns StateMachine

Properties

_currentStateNode

_currentStateNode: State | null

Readonly addressSpace

addressSpace: AddressSpace

Readonly browseName

browseName: QualifiedName

Readonly currentState

currentState: UAVariablePublic

property: currentState

Readonly description

description: LocalizedText

Readonly displayName

displayName: LocalizedText[]

Readonly eventNotifier

eventNotifier: number

Readonly hasMethods

hasMethods: boolean

Readonly initialState

get initialState(): UAObject

- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:146
return the node InitialStateType

property

initialState

Returns UAObject

Optional Readonly lastTransition

lastTransition: TransitionVariable | null

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 nodeVersion

nodeVersion: UAVariableT<string, String>

NodeVersion (Optional) String The NodeVersion Property is used to indicate the version of a Node. The NodeVersion Property is updated each time a Reference is added or deleted to the Node the Property belongs to. Attribute value changes do not cause the NodeVersion to change. Clients may read the NodeVersion Property or subscribe to it to determine when the structure of a Node has changed.

Optional onFirstBrowseAction

onFirstBrowseAction: function

Type declaration

- (this: BaseNode): Promise<void>
- Parameters
  - this: BaseNode
  Returns Promise<void>

parent

parent: BaseNode | null

Optional Readonly parentNodeId

parentNodeId: NodeId

Readonly states

get states(): any[]

- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:102
Returns any[]

Readonly symbolicName

symbolicName: string

Readonly transitions

get transitions(): Transition[]

- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:138
Returns Transition[]

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAObjectType

Accessors

currentStateNode

get currentStateNode(): State | null
set currentStateNode(value: State | null): void

- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:259
property

currentStateNode

Returns State | null
- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:267
property

currentStateNode

Parameters
- value: State | null
Returns void

Methods

_bubble_up_event

_bubble_up_event(eventData: any): void

Inherited from UAAcknowledgeableConditionBase._bubble_up_event
- Defined in packages/node-opcua-address-space/src/ua_object.ts:136
Parameters
- eventData: any
Returns void

_conditionRefresh

_conditionRefresh(_cache?: any): void

Inherited from UAAcknowledgeableConditionBase._conditionRefresh
- Defined in packages/node-opcua-address-space/src/ua_object.ts:182
Parameters
- Optional _cache: any
Returns void

addListener

addListener(event: string | symbol, listener: function): this

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

addReference

addReference(options: AddReferenceOpts): void

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

allReferences

allReferences(): Reference[]

Inherited from UAStateVariable.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 UAStateVariable.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 State.clone

Overrides UAAcknowledgeableConditionBase.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 UAStateVariable.emit
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from UAStateVariable.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

findReference

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

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

findReferences

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

Inherited from UAStateVariable.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 UAStateVariable.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 UAStateVariable.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 UAStateVariable.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 | null

Overrides StateMachineB.findTransitionNode
- Defined in packages/node-opcua-address-space/source/interfaces/state_machine/state_machine.ts:399
Parameters
- fromStateNode: State
- toStateNode: State
- Optional predicate: TransitionSelector
Returns Transition | null

fullName

fullName(): string

Inherited from UAStateVariable.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 UAStateVariable.getAggregates
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:281
Returns BaseNode[]

getChildByName

getChildByName(browseName: string | QualifiedName): BaseNode | null

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

getComponentByName

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

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

getComponents

getComponents(): BaseNode[]

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

getCurrentState

getCurrentState(): string | null

Overrides StateMachineB.getCurrentState
- Defined in packages/node-opcua-address-space/source/interfaces/state_machine/state_machine.ts:401
Returns string | null

getEventSourceOfs

getEventSourceOfs(): BaseNode[]

Inherited from UAStateVariable.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 UAStateVariable.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 | null

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

getMaxListeners

getMaxListeners(): number

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

getMethodById

getMethodById(nodeId: NodeId): UAMethod | null

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

getMethodByName

getMethodByName(methodName: string): UAMethod | null

Inherited from State.getMethodByName

Overrides UAAcknowledgeableConditionBase.getMethodByName
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:780
Parameters
- methodName: string
Returns UAMethod | null

getMethods

getMethods(): UAMethod[]

Inherited from State.getMethods

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

getNotifiers

getNotifiers(): BaseNode[]

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

getProperties

getProperties(): BaseNode[]

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

getPropertyByName

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

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

getStateByName

getStateByName(name: string): State | null

Overrides StateMachineB.getStateByName
- Defined in packages/node-opcua-address-space/source/interfaces/state_machine/state_machine.ts:395
method

getStateByName

Parameters
- name: string
  
  the name of the state to get
Returns State | null

the state with the given name

getStates

getStates(): State[]

Overrides StateMachineB.getStates
- Defined in packages/node-opcua-address-space/source/interfaces/state_machine/state_machine.ts:391
Returns State[]

getTransitions

getTransitions(): Transition[]

Overrides StateMachineB.getTransitions
- Defined in packages/node-opcua-address-space/source/interfaces/state_machine/state_machine.ts:393
Returns Transition[]

install_extra_properties

install_extra_properties(): void

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

isValidTransition

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

Overrides StateMachineB.isValidTransition
- Defined in packages/node-opcua-address-space/source/interfaces/state_machine/state_machine.ts:397
method

isValidTransition

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

listenerCount

listenerCount(event: string | symbol): number

Inherited from UAStateVariable.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 UAStateVariable.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

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

on

on(eventName: "event", eventHandler: function): this

Inherited from State.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:786
Parameters
- eventName: "event"
- eventHandler: function
  - - (eventData: IEventData): void
    - Parameters
      - eventData: IEventData
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

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

prependListener

prependListener(event: string | symbol, listener: function): this

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

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

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

propagate_back_references

propagate_back_references(): void

Inherited from UAStateVariable.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 State.raiseEvent

Overrides EventRaiser.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 UAStateVariable.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

readAttribute

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

Inherited from NonHierarchicalReferences.readAttribute

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

removeAllListeners

removeAllListeners(event?: string | symbol): this

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

removeListener

removeListener(event: string | symbol, listener: function): this

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

removeReference

removeReference(referenceOpts: AddReferenceOpts): void

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

setMaxListeners

setMaxListeners(n: number): this

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

setState

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

Overrides StateMachineB.setState
- Defined in packages/node-opcua-address-space/source/interfaces/state_machine/state_machine.ts:403
method

setState

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

toString

toString(): string

Inherited from UAAcknowledgeableConditionBase.toString
- Defined in packages/node-opcua-address-space/src/ua_object.ts:186
Returns string

writeAttribute

writeAttribute(context: SessionContext, writeValue: any, callback: function): void

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

Class StateMachine

Hierarchy

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: any

Returns StateMachine

Properties

_currentStateNode

Readonly addressSpace

Readonly browseName

Readonly currentState

Readonly description

Readonly displayName

Readonly eventNotifier

Readonly hasMethods

Readonly initialState

Returns UAObject

Optional Readonly lastTransition

Optional Readonly modellingRule

Readonly namespace

Readonly namespaceIndex

Readonly namespaceUri

Readonly nodeClass

Readonly nodeId

Optional nodeVersion

Optional onFirstBrowseAction

Type declaration

Parameters

this: BaseNode

Returns Promise<void>

parent

Optional Readonly parentNodeId

Readonly states

Returns any[]

Readonly symbolicName

Readonly transitions

Returns Transition[]

typeDefinition

typeDefinitionObj

Accessors

currentStateNode

Returns State | null

Parameters

value: State | null

Returns void

Methods

_bubble_up_event

Parameters

eventData: any

Returns void

_conditionRefresh

Parameters

Optional _cache: any

Returns void

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

addReference

Parameters

options: AddReferenceOpts

Returns void

allReferences

Returns Reference[]

browseNode

Parameters

browseDescription: BrowseDescriptionOptions

Optional session: SessionContext

Returns ReferenceDescription[]

clone