The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.5.4

    • APIs

    Show:

    ReferenceType Class

    Extends BaseNode
    Defined in: packages\node-opcua-address-space\src\referenceType.js:24
    Module: opcua.address_space

    Constructor

    ReferenceType

    (
    • options
    )

    Defined in packages\node-opcua-address-space\src\referenceType.js:24

    Parameters:

    • options Object

    Methods

    _clone

    (
    • Constructor
    • options
    • extraInfo
    • optionalFilter
    )
    private

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:1928

    Parameters:

    • Constructor Function
    • options Object
    • extraInfo Object
    • optionalFilter Object

    Returns:

    :

    _clone_children_references

    (
    • newParent
    • [optionalFilter = null]
    • [extraInfo]
    )
    Array private

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:1909

    clone properties and methods

    Parameters:

    • newParent Object

      the new parent object to which references of type HasChild will be attached

    • [optionalFilter = null] Function optional

      a filter

    • [extraInfo] Object optional

    Returns:

    Array:

    addReference

    (
    • reference
    )

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:1076

    Parameters:

    • reference Object
      • referenceType String
      • [isForward= true] Boolean optional
      • nodeId Node | NodeId | String

    Example:

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

    or

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

    browseNode

    (
    • browseDescription
    • session
    )
    ReferenceDescription[]

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:1700

    browse the node to extract information requested in browseDescription

    Parameters:

    Returns:

    ReferenceDescription[]:

    browseNodeByTargetName

    (
    • relativePathElement
    )
    NodeId[]

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:1326

    Parameters:

    Returns:

    NodeId[]:

    dispose

    ()

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:2137

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

    findReference

    (
    • strReference
    • [isForward]
    • [optionalSymbolicName]
    )
    Reference

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:425

    Parameters:

    • strReference String

      the referenceType as a string.

    • [isForward] Boolean | Null optional
    • [optionalSymbolicName] String optional

    Returns:

    Reference:

    findReferences

    (
    • referenceType
    • [isForward=true]
    )
    Array

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:377

    Parameters:

    • referenceType String | NodeId | ReferenceType

      the referenceType as a string.

    • [isForward=true] Boolean optional

    Returns:

    Array:

    full_name

    () String

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:1294

    Returns:

    String:

    the full path name of the node

    getAggregates

    () BaseNode[]

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:576

    Returns:

    BaseNode[]:

    return an array with the Aggregates of this object.

    getAllSubtypes

    () ReferenceType[]

    Defined in packages\node-opcua-address-space\src\referenceType.js:121

    returns a array of all ReferenceTypes in the addressSpace that are self or a subType of self

    Returns:

    ReferenceType[]:

    getComponentByName

    (
    • browseName
    • [namespaceIndex=null]
    )
    BaseNode | Null

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:656

    retrieve a component by name

    Parameters:

    • browseName Object
    • [namespaceIndex=null] Object optional

    Returns:

    BaseNode | Null:

    getComponents

    () BaseNode[]

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:589

    Returns:

    BaseNode[]:

    return an array with the components of this object.

    getEventSourceOfs

    () BaseNode[]

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:642

    Returns:

    BaseNode[]:

    return a array of the objects for which this node is an EventSource

    getEventSources

    () BaseNode[]

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:629

    Returns:

    BaseNode[]:

    return a array with the event source of this object.

    getFalseSubStates

    () BaseNode[]

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:2216

    Returns:

    BaseNode[]:

    return an array with the SubStates of this object.

    getFolderElements

    () Array

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:699

    returns the list of nodes that this folder object organizes

    Returns:

    Array:

    getMethodById

    (
    • nodeId
    )
    UAMethod | Null

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:739

    Parameters:

    • nodeId Object

    Returns:

    UAMethod | Null:

    getMethodByName

    (
    • browseName
    • [namespaceIndex=null]
    )
    UAMethod | Null

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:767

    Parameters:

    • browseName Object
    • [namespaceIndex=null] Object optional

    Returns:

    UAMethod | Null:

    getMethods

    () Array

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:709

    returns the list of methods that this object provides

    Returns:

    Array:

    returns an array wit"h Method objects.

    Note: internally, methods are special types of components

    getNotifiers

    () BaseNode[]

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:616

    Returns:

    BaseNode[]:

    return a array with the notifiers of this object.

    getProperties

    () BaseNode[]

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:603

    Returns:

    BaseNode[]:

    return a array with the properties of this object.

    getPropertyByName

    (
    • browseName
    • [namespaceIndex=null]
    )
    BaseNode | Null

    Inherited from BaseNode but overwritten in packages\node-opcua-address-space\src\base_node.js:670

    retrieve a property by name

    Parameters:

    • browseName Object
    • [namespaceIndex=null] Object optional

    Returns:

    BaseNode | Null:

    getTrueSubStates

    () BaseNode[]

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:2224

    Returns:

    BaseNode[]:

    return an array with the SubStates of this object.

    isArgumentValid

    (
    • addressSpace
    • argDefinition
    • arg
    )
    Boolean private

    Inherited from BaseNode: packages\node-opcua-address-space\src\argument_list.js:149

    Parameters:

    Returns:

    Boolean:

    isSupertypeOf

    (
    • baseType
    )
    Boolean

    Defined in packages\node-opcua-address-space\src\referenceType.js:76

    returns true if self is a super type of baseType

    Parameters:

    Returns:

    Boolean:

    true if self is a Subtype of baseType

    Example:

    normalize_referenceTypeId

    (
    • addressSpace
    • referenceTypeId
    )
    NodeId

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:1529

    Parameters:

    • addressSpace AddressSpace
    • referenceTypeId String | NodeId | Null

      : the referenceType either as a string or a nodeId

    Returns:

    NodeId:

    propagate_back_references

    ()

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:984

    this methods propagates the forward references to the pointed node by inserting backward references to the counter part node

    readAttribute

    (
    • attributeId
    • [indexRange]
    • [dataEncoding]
    )
    DataValue

    Inherited from BaseNode but overwritten in packages\node-opcua-address-space\src\referenceType.js:42

    Parameters:

    • attributeId AttributeIds
    • [indexRange] NumericalRange optional
    • [dataEncoding] String optional

    Returns:

    DataValue:

    removeReference

    (
    • reference
    )

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:1109

    Parameters:

    • reference Object

    Returns:

    void

    resolveNodeId

    (
    • nodeId
    )
    NodeId

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:851

    Parameters:

    • nodeId Object

    Returns:

    NodeId:

    unpropagate_back_references

    () private

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:1155

    Undo the effect of propagate_back_references

    verifyArguments_ArgumentList

    (
    • addressSpace
    • methodInputArguments
    • inputArguments
    )

    Inherited from BaseNode: packages\node-opcua-address-space\src\argument_list.js:202

    Parameters:

    Returns:

    statusCode,inputArgumentResults

    writeAttribute

    (
    • context
    • writeValue
    • callback
    )
    async

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:1268

    Parameters:

    • context SessionContext
    • writeValue Object
      • attributeId AttributeId
      • dataValue DataValue
      • indexRange NumericRange
    • callback Function

    Properties

    hasMethods

    Boolean

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:730

    returns true if the object has some opcua methods

    modellingRule

    String | Undefined

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:2172

    subtypeOf

    NodeId

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:781

    returns the nodeId of the Type which is the super type of this

    typeDefinition

    NodeId

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:544

    returns the nodeId of this node's Type Definition

    typeDefinitionObj

    BaseNode

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:560

    returns the nodeId of this node's Type Definition

    Events

    Description_changed

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:229

    fires when the description attribute is changed.

    Event Payload:

    DisplayName_changed

    Inherited from BaseNode: packages\node-opcua-address-space\src\base_node.js:191

    fires when the displayName is changed.

    Event Payload: