Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UAMethod

Hierarchy

Implements

  • BaseNode
  • UAMethod

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • options: any

    Returns UAMethod

Properties

Optional _asyncExecutionFunction

_asyncExecutionFunction: MethodFunctor

Optional _getExecutableFlag

_getExecutableFlag: function

Type declaration

_permissions

_permissions: Permissions | null

Readonly browseName

browseName: QualifiedName

Optional Readonly inputArguments

inputArguments: UAVariable

methodDeclarationId

methodDeclarationId: NodeId

Readonly nodeClass

nodeClass: Method = NodeClass.Method

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: BaseNodePublic): Promise<void>
    • Parameters

      • this: BaseNodePublic

      Returns Promise<void>

Optional Readonly outputArguments

outputArguments: UAVariable

Optional value

value: any

Accessors

addressSpace

description

  • get description(): LocalizedText
  • set description(value: LocalizedText): void

displayName

  • get displayName(): LocalizedText[]
  • set displayName(value: LocalizedText[]): void

fromStateNode

isFalseSubStateOf

  • get isFalseSubStateOf(): BaseNodePublic | null
  • property

    isFalseSubStateOf

    Returns BaseNodePublic | null

isTrueSubStateOf

  • get isTrueSubStateOf(): BaseNodePublic | null
  • property

    isTrueSubStateOf

    Returns BaseNodePublic | null

modellingRule

namespace

namespaceIndex

  • get namespaceIndex(): number

namespaceUri

  • get namespaceUri(): string

parent

  • get parent(): UAObjectPublic | null
  • Returns UAObjectPublic | null

parentNodeId

  • get parentNodeId(): NodeId | undefined

toStateNode

typeDefinition

  • get typeDefinition(): NodeId
  • returns the nodeId of this node's Type Definition

    Returns NodeId

typeDefinitionObj

  • get typeDefinitionObj(): UAObjectType

Methods

_on_child_added

  • _on_child_added(): void

_on_child_removed

  • _on_child_removed(obj: BaseNode): void

addListener

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

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

addReference

  • method

    addReference

    example
    view.addReference({ referenceType: "Organizes", nodeId: myDevice });

    or

    myDevice1.addReference({ referenceType: "OrganizedBy", nodeId: view });

    Parameters

    Returns void

allReferences

bindMethod

  • Parameters

    Returns void

  • Parameters

    Returns void

browseNode

  • browseNode(browseDescription: BrowseDescription, context?: SessionContext): ReferenceDescription[]
  • browse the node to extract information requested in browseDescription

    method

    browseNode

    Parameters

    • browseDescription: BrowseDescription
    • Optional context: SessionContext

    Returns ReferenceDescription[]

    an array with reference descriptions

browseNodeByTargetName

  • browseNodeByTargetName(relativePathElement: RelativePathElement, isLast: boolean): NodeId[]
  • method

    browseNodeByTargetName

    Parameters

    • relativePathElement: RelativePathElement
    • isLast: boolean

    Returns NodeId[]

clone

  • clone(options: any, optionalFilter?: any, extraInfo?: any): UAMethodPublic
  • clone(options: any, optionalFilter?: any, extraInfo?: any): UAMethod
  • Parameters

    • options: any
    • Optional optionalFilter: any
    • Optional extraInfo: any

    Returns UAMethodPublic

  • Parameters

    • options: any
    • Optional optionalFilter: any
    • Optional extraInfo: any

    Returns UAMethod

dispose

  • dispose(): void
  • the dispose method should be called when the node is no longer used, to release back pointer to the address space and clear caches.

    method

    dispose

    Returns void

dumpXML

  • Parameters

    Returns void

emit

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

eventNames

  • eventNames(): Array<string | symbol>

execute

  • Parameters

    Returns Promise<CallMethodResultOptions>

  • Parameters

    Returns void

  • async

    Parameters

    Returns void

  • Parameters

    Returns Promise<CallMethodResultOptions>

findHierarchicalReferences

findReference

  • findReference(strReference: string, isForward?: boolean): UAReferencePublic | null
  • method

    findReference

    Parameters

    • strReference: string

      the referenceType as a string.

    • Optional isForward: boolean

    Returns UAReferencePublic | null

findReferences

  • findReferences(referenceType: string | NodeId | UAReferenceTypePublic, isForward?: boolean): UAReferencePublic[]
  • method

    findReferences

    Parameters

    • referenceType: string | NodeId | UAReferenceTypePublic

      the referenceType as a string.

    • Optional isForward: boolean

    Returns UAReferencePublic[]

    an array with references

findReferencesAsObject

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

findReferencesEx

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

findReferencesExAsObject

fullName

  • fullName(): string

getAggregates

  • return an array with the Aggregates of this object.

    Returns BaseNode[]

getChildByName

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

getComponentByName

  • getComponentByName(browseName: QualifiedNameLike, namespaceIndex?: number): UAVariablePublic | UAObjectPublic | null
  • retrieve a component by name

    Parameters

    Returns UAVariablePublic | UAObjectPublic | null

getComponents

  • return an array with the components of this object.

    Returns BaseNode[]

getDisplayName

  • getDisplayName(locale?: string): string
  • Parameters

    • Optional locale: string

    Returns string

getEventSourceOfs

getEventSources

getExecutableFlag

  • Parameters

    Returns boolean

  • Parameters

    Returns boolean

getFalseSubStates

  • method

    getFalseSubStates

    Returns UAStateVariable[]

    return an array with the SubStates of this object.

getFolderElementByName

  • getFolderElementByName(browseName: string, namespaceIndex?: number): BaseNode | null
  • retrieve a folder by name

    Parameters

    • browseName: string
    • Optional namespaceIndex: number

    Returns BaseNode | null

getFolderElements

  • returns the list of nodes that this folder object organizes

    Returns BaseNode[]

getInputArguments

  • getInputArguments(): Argument[]
  • getInputArguments(): Argument[]
  • Returns Argument[]

  • Returns Argument[]

getMaxListeners

  • getMaxListeners(): number

getMethodById

  • getMethodById(nodeId: NodeId): UAMethodPublic | null
  • returns the method exposed by this object and with the given nodeId

    Parameters

    • nodeId: NodeId

    Returns UAMethodPublic | null

getMethodByName

  • getMethodByName(browseName: string, namespaceIndex?: number): UAMethodPublic | null
  • Parameters

    • browseName: string
    • Optional namespaceIndex: number

    Returns UAMethodPublic | null

getMethods

  • getMethods(): UAMethodPublic[]
  • returns the list of methods that this object provides

    method

    getMethods

    Returns UAMethodPublic[]

    an array with Method objects.

    Note: internally, methods are special types of components

getNotifiers

  • return a array with the notifiers of this object.

    Returns BaseNode[]

getOutputArguments

  • getOutputArguments(): Argument[]
  • getOutputArguments(): Argument[]
  • Returns Argument[]

  • Returns Argument[]

getProperties

  • return a array with the properties of this object.

    Returns BaseNode[]

getPropertyByName

  • getPropertyByName(browseName: string, namespaceIndex?: number): UAVariablePublic | null
  • retrieve a property by name

    Parameters

    • browseName: string
    • Optional namespaceIndex: number

    Returns UAVariablePublic | null

getTrueSubStates

  • method

    getTrueSubStates

    Returns UAStateVariable[]

    return an array with the SubStates of this object.

getUserWriteMask

  • getUserWriteMask(): number

getWriteMask

  • getWriteMask(): number
  • Returns number

installPostInstallFunc

  • installPostInstallFunc(f: any): void

install_extra_properties

  • install_extra_properties(): void

isBound

  • isBound(): boolean
  • isBound(): boolean
  • Returns boolean

  • Returns boolean

listenerCount

  • listenerCount(event: string | symbol): number

listeners

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

off

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

once

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

ownReferences

prependListener

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

prependOnceListener

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

propagate_back_references

  • propagate_back_references(): void

rawListeners

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

readAttribute

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeListener

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

removeReference

resolveNodeId

setMaxListeners

  • setMaxListeners(n: number): this

setPermissions

  • Parameters

    Returns void

  • Parameters

    Returns void

toString

  • toString(): string
  • Returns string

uninstall_extra_properties

  • uninstall_extra_properties(reference: Reference): void

unpropagate_back_references

  • unpropagate_back_references(): void

writeAttribute

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

Static checkValidArgument

  • checkValidArgument(args: any): boolean
  • Parameters

    • args: any

    Returns boolean

Static makeAttributeEventName

Generated using TypeDoc