StateVariable | node-opcua-client

Hierarchy

UAVariableT<LocalizedText>
StateVariableB
- StateVariable

Index

Methods

Properties

accessLevel

accessLevel: number

addressSpace

addressSpace: AddressSpace

arrayDimensions

arrayDimensions: number[]

browseName

browseName: QualifiedName

dataType

dataType: NodeId

dataTypeObj

dataTypeObj: UADataType

description

description: LocalizedText

displayName

displayName: LocalizedText[]

Optional effectiveDisplayName

effectiveDisplayName: UAVariableT<LocalizedText>

effective display name

contains a human readable name for the current state of the state machine after taking the state of any SubStateMachines in account. There is no rule specified for which state or sub-state should be used. It is up to the Server and will depend on the semantics of the StateMachineType

historizing

historizing: boolean

id

id: UAVariableT<UAString | UInt32>

minimumSamplingInterval

minimumSamplingInterval: number

Optional modellingRule

modellingRule: ModellingRuleType

Optional name

name: UAVariableT<QualifiedName>

namespace

namespace: Namespace

namespaceIndex

namespaceIndex: number

namespaceUri

namespaceUri: string

nodeClass

nodeClass: Variable

nodeId

nodeId: NodeId

Optional number

number: UAVariableT<UInt32>

number is an integer which uniquely identifies the current state within the StateMachineType

parent

parent: BaseNode | null

Optional parentNodeId

parentNodeId: NodeId

semantic_version

semantic_version: number

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAVariableType

userAccessLevel

userAccessLevel: number

valueRank

valueRank: number

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

asyncRefresh

asyncRefresh(callback: DataValueCallback): void
asyncRefresh(): Promise<DataValue>

Inherited from UAVariable.asyncRefresh
- Defined in node-opcua-address-space/source/address_space_ts.ts:448
Parameters
- callback: DataValueCallback
Returns void
Inherited from UAVariable.asyncRefresh
- Defined in node-opcua-address-space/source/address_space_ts.ts:452
Returns Promise<DataValue>

bindExtensionObject

bindExtensionObject(optionalExtensionObject?: ExtensionObject): ExtensionObject | null

Inherited from UAVariable.bindExtensionObject
- Defined in node-opcua-address-space/source/address_space_ts.ts:475
Parameters
- Optional optionalExtensionObject: ExtensionObject
Returns ExtensionObject | null

bindVariable

bindVariable(options: BindVariableOptions, overwrite?: boolean): void

Inherited from UAVariable.bindVariable
- Defined in node-opcua-address-space/source/address_space_ts.ts:470
Parameters
- options: BindVariableOptions
- Optional overwrite: boolean
Returns void

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

clone

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

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

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

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

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

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

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

historyRead

historyRead(context: SessionContext, historyReadDetails: HistoryReadDetails, indexRange: NumericRange | null, dataEncoding: QualifiedNameLike | null, continuationPoint?: ContinuationPoint): Promise<HistoryReadResult>
historyRead(context: SessionContext, historyReadDetails: HistoryReadDetails, indexRange: NumericRange | null, dataEncoding: QualifiedNameLike | null, continuationPoint: ContinuationPoint | null, callback: Callback<HistoryReadResult>): void

Inherited from UAVariable.historyRead
- Defined in node-opcua-address-space/source/address_space_ts.ts:479
Parameters
- context: SessionContext
- historyReadDetails: HistoryReadDetails
- indexRange: NumericRange | null
- dataEncoding: QualifiedNameLike | null
- Optional continuationPoint: ContinuationPoint
Returns Promise<HistoryReadResult>
Inherited from UAVariable.historyRead
- Defined in node-opcua-address-space/source/address_space_ts.ts:487
Parameters
- context: SessionContext
- historyReadDetails: HistoryReadDetails
- indexRange: NumericRange | null
- dataEncoding: QualifiedNameLike | null
- continuationPoint: ContinuationPoint | null
- callback: Callback<HistoryReadResult>
Returns void

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

isReadable

isReadable(context: SessionContext): boolean

Inherited from UAVariable.isReadable
- Defined in node-opcua-address-space/source/address_space_ts.ts:364
Parameters
- context: SessionContext
Returns boolean

isUserReadable

isUserReadable(context: SessionContext): boolean

Inherited from UAVariable.isUserReadable
- Defined in node-opcua-address-space/source/address_space_ts.ts:366
Parameters
- context: SessionContext
Returns boolean

isUserWritable

isUserWritable(context: SessionContext): boolean

Inherited from UAVariable.isUserWritable
- Defined in node-opcua-address-space/source/address_space_ts.ts:370
Parameters
- context: SessionContext
Returns boolean

isWritable

isWritable(context: SessionContext): boolean

Inherited from UAVariable.isWritable
- Defined in node-opcua-address-space/source/address_space_ts.ts:368
Parameters
- context: SessionContext
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: "semantic_changed", eventHandler: function): this
on(eventName: "value_changed", eventHandler: function): this

Inherited from UAVariable.on

Overrides EventEmitter.on
- Defined in node-opcua-address-space/source/address_space_ts.ts:503
Parameters
- eventName: "semantic_changed"
- eventHandler: function
  - - (): void
    - Returns void
Returns this
Inherited from UAVariable.on

Overrides EventEmitter.on
- Defined in node-opcua-address-space/source/address_space_ts.ts:505
Parameters
- eventName: "value_changed"
- eventHandler: function
  - - (dataValue: DataValue): void
    - Parameters
      - dataValue: DataValue
      Returns void
Returns this

once

once(eventName: "semantic_changed", eventHandler: function): this
once(eventName: "value_changed", eventHandler: function): this

Inherited from UAVariable.once

Overrides EventEmitter.once
- Defined in node-opcua-address-space/source/address_space_ts.ts:507
Parameters
- eventName: "semantic_changed"
- eventHandler: function
  - - (): void
    - Returns void
Returns this
Inherited from UAVariable.once

Overrides EventEmitter.once
- Defined in node-opcua-address-space/source/address_space_ts.ts:509
Parameters
- eventName: "value_changed"
- eventHandler: function
  - - (dataValue: DataValue): void
    - Parameters
      - dataValue: DataValue
      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

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 UAVariable.readAttribute

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

readEnumValue

readEnumValue(): EnumValue2

Inherited from UAVariable.readEnumValue
- Defined in node-opcua-address-space/source/address_space_ts.ts:412
Returns EnumValue2

readValue

readValue(context?: SessionContext, indexRange?: NumericRange, dataEncoding?: QualifiedNameLike | null): DataValueT<LocalizedText>

Inherited from UAVariableT.readValue

Overrides UAVariable.readValue
- Defined in node-opcua-address-space/source/address_space_ts.ts:2491
Parameters
- Optional context: SessionContext
- Optional indexRange: NumericRange
- Optional dataEncoding: QualifiedNameLike | null
Returns DataValueT<LocalizedText>

readValueAsync

readValueAsync(context?: SessionContext | null): Promise<DataValue>
readValueAsync(context: SessionContext | null, callback: DataValueCallback): void

Inherited from UAVariable.readValueAsync
- Defined in node-opcua-address-space/source/address_space_ts.ts:403
Parameters
- Optional context: SessionContext | null
Returns Promise<DataValue>
Inherited from UAVariable.readValueAsync
- Defined in node-opcua-address-space/source/address_space_ts.ts:407
Parameters
- context: SessionContext | null
- callback: DataValueCallback
Returns void

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

setPermissions

setPermissions(permissions: Permissions): void

Inherited from UAVariable.setPermissions
- Defined in node-opcua-address-space/source/address_space_ts.ts:468
Parameters
- permissions: Permissions
Returns void

setValueFromSource

setValueFromSource(value: VariantLike, statusCode?: StatusCode, sourceTimestamp?: Date): void

Inherited from UAVariable.setValueFromSource
- Defined in node-opcua-address-space/source/address_space_ts.ts:423
Parameters
- value: VariantLike
- Optional statusCode: StatusCode
- Optional sourceTimestamp: Date
Returns void

touchValue

touchValue(updateNow?: PreciseClock): void

Inherited from UAVariable.touchValue
- Defined in node-opcua-address-space/source/address_space_ts.ts:466
Parameters
- Optional updateNow: PreciseClock
Returns void

writeAttribute

writeAttribute(context: SessionContext, writeValue: WriteValueOptions, callback: StatusCodeCallBack): void
writeAttribute(context: SessionContext, writeValue: WriteValueOptions): Promise<StatusCode>

Inherited from UAVariable.writeAttribute

Overrides BaseNode.writeAttribute
- Defined in node-opcua-address-space/source/address_space_ts.ts:454
Parameters
- context: SessionContext
- writeValue: WriteValueOptions
- callback: StatusCodeCallBack
Returns void
Inherited from UAVariable.writeAttribute

Overrides BaseNode.writeAttribute
- Defined in node-opcua-address-space/source/address_space_ts.ts:460
Parameters
- context: SessionContext
- writeValue: WriteValueOptions
Returns Promise<StatusCode>

writeEnumValue

writeEnumValue(value: string | number): void

Inherited from UAVariable.writeEnumValue
- Defined in node-opcua-address-space/source/address_space_ts.ts:414
Parameters
- value: string | number
Returns void

writeValue

writeValue(context: SessionContext, dataValue: DataValueT<LocalizedText>, indexRange: NumericRange | null, callback: function): void
writeValue(context: SessionContext, dataValue: DataValueT<LocalizedText>, callback: function): void
writeValue(context: SessionContext, dataValue: DataValueT<LocalizedText>, indexRange?: NumericRange | null): Promise<StatusCode>

Inherited from UAVariableT.writeValue

Overrides UAVariable.writeValue
- Defined in node-opcua-address-space/source/address_space_ts.ts:2497
Parameters
- context: SessionContext
- dataValue: DataValueT<LocalizedText>
- indexRange: NumericRange | null
- callback: function
  - - (err: Error | null, statusCode?: StatusCode): void
    - Parameters
      - err: Error | null
      - Optional statusCode: StatusCode
      Returns void
Returns void
Inherited from UAVariableT.writeValue

Overrides UAVariable.writeValue
- Defined in node-opcua-address-space/source/address_space_ts.ts:2504
Parameters
- context: SessionContext
- dataValue: DataValueT<LocalizedText>
- callback: function
  - - (err: Error | null, statusCode?: StatusCode): void
    - Parameters
      - err: Error | null
      - Optional statusCode: StatusCode
      Returns void
Returns void
Inherited from UAVariableT.writeValue

Overrides UAVariable.writeValue
- Defined in node-opcua-address-space/source/address_space_ts.ts:2510
Parameters
- context: SessionContext
- dataValue: DataValueT<LocalizedText>
- Optional indexRange: NumericRange | null
Returns Promise<StatusCode>

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

accessLevel

addressSpace

arrayDimensions

browseName

dataType

dataTypeObj

description

displayName

Optional effectiveDisplayName

historizing

id

minimumSamplingInterval

Optional modellingRule

Optional name

namespace

namespaceIndex

namespaceUri

nodeClass

nodeId

Optional number

parent

Optional parentNodeId

semantic_version

typeDefinition

typeDefinitionObj

userAccessLevel

valueRank

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

asyncRefresh

Parameters

callback: DataValueCallback

Returns void

Returns Promise<DataValue>

bindExtensionObject

Parameters

Optional optionalExtensionObject: ExtensionObject

Returns ExtensionObject | null

bindVariable

Parameters

options: BindVariableOptions

Optional overwrite: boolean

Returns void

browseNode

Parameters

browseDescription: BrowseDescriptionOptions

Optional session: SessionContext

Returns ReferenceDescription[]

clone

Parameters

Optional options: any

Optional optionalFilter: any

Optional extraInfo: any

Returns UAVariable

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>