StateVariableType | NodeOPCUA reference documentation

Hierarchy

UAVariableTypeT<LocalizedText, LocalizedText>
_UAStateVariable
- StateVariableType

Index

Properties

Readonly addressSpace

addressSpace: AddressSpace

arrayDimensions

arrayDimensions: number[]

Readonly browseName

browseName: QualifiedName

dataType

dataType: NodeId

Readonly description

description: LocalizedText

Readonly displayName

displayName: LocalizedText[]

Optional Readonly effectiveDisplayName

effectiveDisplayName: UAVariableT<LocalizedText, 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: UAVariable

isAbstract

isAbstract: false

minimumSamplingInterval

minimumSamplingInterval: number

Optional Readonly modellingRule

modellingRule: ModellingRuleType

Optional Readonly name

name: UAVariableT<QualifiedName, QualifiedName>

Readonly namespace

namespace: Namespace

Readonly namespaceIndex

namespaceIndex: number

Readonly namespaceUri

namespaceUri: string

Readonly nodeClass

nodeClass: VariableType

Readonly nodeId

nodeId: NodeId

Optional Readonly number

number: UAVariableT<number, UInt32>

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

Optional onFirstBrowseAction

onFirstBrowseAction: () => Promise<void>

Type declaration

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

Optional Readonly parentNodeId

parentNodeId: NodeId

Readonly subtypeOf

subtypeOf: NodeId

Readonly subtypeOfObj

subtypeOfObj: UAVariableType

valueRank

valueRank: number

Methods

addListener

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

Inherited from UAVariableTypeT.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 StateVariableType

addReference

addReference(options: AddReferenceOpts): void

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

allReferences

allReferences(): Reference[]

Inherited from UAVariableTypeT.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 UAVariableTypeT.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[]

emit

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

Inherited from UAVariableTypeT.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 UAVariableTypeT.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

findReference

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

Inherited from UAVariableTypeT.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 UAVariableTypeT.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 UAVariableTypeT.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 UAVariableTypeT.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 UAVariableTypeT.findReferencesExAsObject
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:195
Parameters
- strReference: string
- Optional browseDirection: BrowseDirection
Returns BaseNode[]

fullName

fullName(): string

Inherited from UAVariableTypeT.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

getChildByName

getChildByName(browseName: string | QualifiedName): BaseNode

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

getEventSourceOfs

getEventSourceOfs(): BaseNode[]

Inherited from UAVariableTypeT.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 UAVariableTypeT.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[]

getMaxListeners

getMaxListeners(): number

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

install_extra_properties

install_extra_properties(): void

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

instantiate

instantiate(options: InstantiateVariableOptions): UAVariableT<LocalizedText, LocalizedText>

Inherited from UAVariableTypeT.instantiate
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2583
Parameters
- options: InstantiateVariableOptions
Returns UAVariableT<LocalizedText, LocalizedText>

isSupertypeOf

isSupertypeOf(type: UAVariableType): boolean

Inherited from UAVariableTypeT.isSupertypeOf
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:992
Parameters
- type: UAVariableType
Returns boolean

listenerCount

listenerCount(event: string | symbol): number

Inherited from UAVariableTypeT.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 UAVariableTypeT.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): StateVariableType

Inherited from UAVariableTypeT.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 StateVariableType

on

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

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

once

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

Inherited from UAVariableTypeT.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 StateVariableType

prependListener

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

Inherited from UAVariableTypeT.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 StateVariableType

prependOnceListener

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

Inherited from UAVariableTypeT.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 StateVariableType

propagate_back_references

propagate_back_references(): void

Inherited from UAVariableTypeT.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

rawListeners

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

Inherited from UAVariableTypeT.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 UAVariableTypeT.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): StateVariableType

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

removeListener

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

Inherited from UAVariableTypeT.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 StateVariableType

removeReference

removeReference(referenceOpts: AddReferenceOpts): void

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

setMaxListeners

setMaxListeners(n: number): StateVariableType

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

writeAttribute

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

Inherited from UAVariableTypeT.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

arrayDimensions

Readonly browseName

dataType

Readonly description

Readonly displayName

Optional Readonly effectiveDisplayName

historizing

id

isAbstract

minimumSamplingInterval

Optional Readonly modellingRule

Optional Readonly name

Readonly namespace

Readonly namespaceIndex

Readonly namespaceUri

Readonly nodeClass

Readonly nodeId

Optional Readonly number

Optional onFirstBrowseAction

Type declaration

Returns Promise<void>

Optional Readonly parentNodeId

Readonly subtypeOf

Readonly subtypeOfObj

valueRank

Methods

addListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns StateVariableType

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 (string | symbol)[]

findReference

Parameters

strReference: string

Optional isForward: boolean

Returns UAReference

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