Class UAMethod

Hierarchy

BaseNode
- UAMethod

Index

Properties

Methods

Properties

Optional _getExecutableFlag

_getExecutableFlag: function

Type declaration

- (sessionContext: SessionContext): boolean
- Parameters
  - sessionContext: SessionContext
  Returns boolean

addressSpace

addressSpace: AddressSpace

browseName

browseName: QualifiedName

description

description: LocalizedText

displayName

displayName: LocalizedText[]

Optional inputArguments

inputArguments: UAVariable

Optional modellingRule

modellingRule: ModellingRuleType

namespace

namespace: Namespace

namespaceIndex

namespaceIndex: number

namespaceUri

namespaceUri: string

nodeClass

nodeClass: Method

nodeId

nodeId: NodeId

Optional outputArguments

outputArguments: UAVariable

parent

parent: UAObject | null

Optional parentNodeId

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

bindMethod

bindMethod(methodFunction: MethodFunctor): void

- Defined in node-opcua-address-space/source/address_space_ts.ts:729
Parameters
- methodFunction: MethodFunctor
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): UAMethod

- Defined in node-opcua-address-space/source/address_space_ts.ts:754
Parameters
- options: any
- Optional optionalFilter: any
- Optional extraInfo: any
Returns UAMethod

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>

execute

execute(inputArguments: VariantLike[] | null, context: SessionContext, callback: MethodFunctorCallback): void
execute(inputArguments: null | VariantLike[], context: SessionContext): Promise<CallMethodResultOptions>

- Defined in node-opcua-address-space/source/address_space_ts.ts:743
async

Parameters
- inputArguments: VariantLike[] | null
- context: SessionContext
- callback: MethodFunctorCallback
Returns void
- Defined in node-opcua-address-space/source/address_space_ts.ts:749
Parameters
- inputArguments: null | VariantLike[]
- context: SessionContext
Returns Promise<CallMethodResultOptions>

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

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

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

getExecutableFlag

getExecutableFlag(context: ISessionContext): boolean

- Defined in node-opcua-address-space/source/address_space_ts.ts:731
Parameters
- context: ISessionContext
Returns boolean

getInputArguments

getInputArguments(): Argument[]

- Defined in node-opcua-address-space/source/address_space_ts.ts:733
Returns Argument[]

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

getOutputArguments

getOutputArguments(): Argument[]

- Defined in node-opcua-address-space/source/address_space_ts.ts:735
Returns Argument[]

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

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(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:12
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      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

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

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

Generated using TypeDoc