ExclusiveLimitStateMachine | node-opcua-client

Hierarchy

StateMachine
- ExclusiveLimitStateMachine

Index

Methods

Properties

addressSpace

addressSpace: AddressSpace

browseName

browseName: QualifiedName

currentState

currentState: StateVariable

description

description: LocalizedText

displayName

displayName: LocalizedText[]

hasMethods

hasMethods: boolean

initialState

initialState: InitialState | null

Optional lastTransition

lastTransition: TransitionVariable | null

Optional modellingRule

modellingRule: ModellingRuleType

namespace

namespace: Namespace

namespaceIndex

namespaceIndex: number

namespaceUri

namespaceUri: string

nodeClass

nodeClass: Object

nodeId

nodeId: NodeId

parent

parent: BaseNode | null

Optional parentNodeId

parentNodeId: NodeId

states

states: State[]

transitions

transitions: Transition[]

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAObjectType

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:11
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

addReference

addReference(options: AddReferenceOpts): void

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

allReferences

allReferences(): Reference[]

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

browseNode

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

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

method

browseNode

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

emit

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

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:23
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:24
Returns Array<string | symbol>

findReference

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

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

findReferences

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

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

findReferencesAsObject

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

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

findReferencesEx

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

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

findReferencesExAsObject

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

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

findTransitionNode

findTransitionNode(fromStateNode: State, toStateNode: State): Transition | null

Inherited from StateMachine.findTransitionNode

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

fullName

fullName(): string

Inherited from BaseNode.fullName
- Defined in node-opcua-address-space/source/address_space_ts.ts:161
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 IPropertyAndComponentHolder.getAggregates
- Defined in node-opcua-address-space/source/address_space_ts.ts:336
Returns BaseNode[]

getChildByName

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

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

getComponentByName

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

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

getComponents

getComponents(): BaseNode[]

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

getCurrentState

getCurrentState(): string | null

Inherited from StateMachine.getCurrentState

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

getEventSourceOfs

getEventSourceOfs(): BaseNode[]

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

Returns BaseNode[]

getEventSources

getEventSources(): BaseNode[]

Inherited from BaseNode.getEventSources
- Defined in node-opcua-address-space/source/address_space_ts.ts:184
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 UAObject.getFolderElementByName
- Defined in node-opcua-address-space/source/address_space_ts.ts:683
Parameters
- browseName: string
- Optional namespaceIndex: number
Returns BaseNode | null

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:20
Returns number

getMethodById

getMethodById(nodeId: NodeId): UAMethod | null

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

getMethodByName

getMethodByName(methodName: string): UAMethod | null

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

getMethods

getMethods(): UAMethod[]

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

getNotifiers

getNotifiers(): BaseNode[]

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

getProperties

getProperties(): BaseNode[]

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

getPropertyByName

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

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

getStateByName

getStateByName(name: string): State | null

Inherited from StateMachine.getStateByName

Overrides StateMachineB.getStateByName
- Defined in node-opcua-address-space/source/interfaces/state_machine.ts:440
Parameters
- name: string
Returns State | null

getStates

getStates(): State[]

Inherited from StateMachine.getStates

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

getTransitions

getTransitions(): Transition[]

Inherited from StateMachine.getTransitions

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

install_extra_properties

install_extra_properties(): void

Inherited from BaseNode.install_extra_properties
- Defined in node-opcua-address-space/source/address_space_ts.ts:194
Returns void

isValidTransition

isValidTransition(toStateNode: State | string): boolean

Inherited from StateMachine.isValidTransition

Overrides StateMachineB.isValidTransition
- Defined in node-opcua-address-space/source/interfaces/state_machine.ts:442
Parameters
- toStateNode: State | string
Returns boolean

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

off

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

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:17
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 UAObject.on

Overrides EventEmitter.on
- Defined in node-opcua-address-space/source/address_space_ts.ts:694
Parameters
- eventName: "event"
- eventHandler: function
  - - (eventData: EventData): void
    - Parameters
      - eventData: EventData
      Returns void
Returns this

once

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

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:13
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 EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:14
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 EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:15
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 BaseNode.propagate_back_references
- Defined in node-opcua-address-space/source/address_space_ts.ts:231
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

Overrides EventRaiser.raiseEvent
- Defined in node-opcua-address-space/source/address_space_ts.ts:692
Parameters
- eventType: EventTypeLike
- eventData: RaiseEventData
Returns void

rawListeners

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

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
Returns Function[]

readAttribute

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:18
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:16
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

removeReference

removeReference(referenceOpts: AddReferenceOpts): void

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

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

setState

setState(toStateNode: State | string): void

Inherited from StateMachine.setState

Overrides StateMachineB.setState
- Defined in node-opcua-address-space/source/interfaces/state_machine.ts:451
Parameters
- toStateNode: State | string
Returns void

writeAttribute

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

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

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:8
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Index

Properties

Methods

Properties

addressSpace

browseName

currentState

description

displayName

hasMethods

initialState

Optional lastTransition

Optional modellingRule

namespace

namespaceIndex

namespaceUri

nodeClass

nodeId

parent

Optional parentNodeId

states

transitions

typeDefinition

typeDefinitionObj

Static defaultMaxListeners

Methods

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

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

findReference

Parameters

strReference: string

Optional isForward: boolean

Returns UAReference | null

findReferences

Parameters

referenceType: string | NodeId | UAReferenceType

Optional isForward: boolean

Returns UAReference[]

findReferencesAsObject

Parameters

strReference: string

isForward: boolean

Returns BaseNode[]

findReferencesEx

Parameters

strReference: string

Optional browseDirection: BrowseDirection

Returns UAReference[]

findReferencesExAsObject

Parameters

strReference: string

Optional browseDirection: BrowseDirection

Returns BaseNode[]

findTransitionNode

Parameters