The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.5.4

    • APIs

    Show:

    Reference Class

    Defined in: packages\node-opcua-address-space\src\reference.js:27
    Module: opcua.address_space

    Constructor

    Reference

    (
    • options.referenceType
    • options.nodeId
    • options.isForward
    )

    Defined in packages\node-opcua-address-space\src\reference.js:27

    Parameters:

    • options.referenceType NodeId
    • options.nodeId NodeId
    • options.isForward Boolean

    Methods

    _addVariable

    () private

    Defined in packages\node-opcua-address-space\src\namespace.js:454

    _arrow

    () private

    Defined in packages\node-opcua-address-space\src\reference.js:44

    Example:

      ---- some text ----->

    _coerce_parent convert a 'string' , NodeId or Object into a valid and existing object

    (
    • addressSpace
    • value
    • coerceFunc
    )
    private

    Defined in packages\node-opcua-address-space\src\namespace.js:798

    Parameters:

    • addressSpace AddressSpace
    • value Object
    • coerceFunc Function

    _createNode

    (
    • options
    )
    BaseNode private

    Defined in packages\node-opcua-address-space\src\namespace.js:367

    Parameters:

    • options Object
      • [nodeId] NodeId optional
      • nodeClass NodeClass
      • browseName String | QualifiedName

        the node browseName the browseName can be either a string : "Hello" a string with a namespace : "1:Hello" a QualifiedName : new QualifiedName({name:"Hello", namespaceIndex:1});

      • [displayName] String | LocalizedText optional

        the node display name

      • [description] String | LocalizedText optional

        the node description

    Returns:

    BaseNode:

    _process_modelling_rule

    (
    • references
    • modellingRule
    )
    private

    Defined in packages\node-opcua-address-space\src\namespace.js:924

    Parameters:

    • references Array

      the array of references

    • modellingRule Reference

      the modellling Rule reference.

    addAlias

    (
    • alias_name
    • nodeId
    )

    Defined in packages\node-opcua-address-space\src\namespace.js:284

    Parameters:

    • alias_name String

      the alias name

    • nodeId NodeId

      NodeId must belong to this namespace

    addElement add a new element in a ExtensionObject Array variable

    (
    • options
    • uaArrayVariableNode
    • nodeVariable
    • uaArrayVariableNode
    • constructor
    • uaArrayVariableNode
    )
    UAVariable

    Defined in packages\node-opcua-address-space\src\extension_object_array_node.js:395

    Parameters:

    • options Object

      data used to construct the underlying ExtensionObject

    • uaArrayVariableNode UAVariable
    • nodeVariable UAVariable

      a variable already exposing an extension objects

    • uaArrayVariableNode UAVariable
    • constructor Function

      constructor of the extension object to create

    • uaArrayVariableNode UAVariable

    Returns:

    UAVariable:

    addFolder

    (
    • parentFolder
    • options
    )
    BaseNode

    Defined in packages\node-opcua-address-space\src\namespace.js:703

    Parameters:

    • parentFolder Object
    • options String | Object
      • browseName String

        the name of the folder

      • [nodeId] NodeId optional

        . An optional nodeId for this object

    Returns:

    BaseNode:

    addObjectType

    (
    • options
    )

    Defined in packages\node-opcua-address-space\src\namespace.js:590

    add a new Object type to the address space

    Parameters:

    • options Object
      • browseName String

        the object type name

      • [displayName] String | LocalizedText optional

        the display name

      • [subtypeOf="BaseObjectType"] String | NodeId | BaseNode optional

        the base class

      • [nodeId] String | NodeId optional

        an optional nodeId for this objectType, if not provided a new nodeId will be created

      • [isAbstract= false] Boolean optional
      • [eventNotifier= 0] Integer optional
      • [postInstantiateFunc= null] Function optional

    addReferenceType

    (
    • options
    )

    Defined in packages\node-opcua-address-space\src\namespace.js:733

    Parameters:

    • options Object
      • isAbstract
      • browseName
      • inverseName

    addVariable

    (
    • options
    )
    Object

    Defined in packages\node-opcua-address-space\src\namespace.js:510

    add a variable as a component of the parent node

    Parameters:

    • options Object
      • browseName String

        the variable name

      • dataType String

        the variable datatype ( "Double", "UInt8" etc...)

      • [typeDefinition="BaseDataVariableType"] optional
      • [modellingRule=null] optional

        the Modelling rule : "Optional" , "Mandatory"

      • [valueRank= -1] Int optional

        the valueRank

      • [arrayDimensions] Null | Array optional

    Returns:

    Object:

    addVariableType

    (
    • options
    )

    Defined in packages\node-opcua-address-space\src\namespace.js:612

    add a new Variable type to the address space

    Parameters:

    • options Object
      • browseName String

        the object type name

      • [displayName] String | LocalizedText optional

        the display name

      • [subtypeOf="BaseVariableType"] String | NodeId | BaseNode optional

        the base class

      • [nodeId] String | NodeId optional

        an optional nodeId for this objectType, if not provided a new nodeId will be created

      • [isAbstract= false] Boolean optional
      • dataType String | NodeId

        the variable DataType

      • [valueRank= -1] optional
      • [arrayDimensions= null] optional

        { Array>

    bindExtObjArrayNode

    (
    • uaArrayVariableNode
    • variableType
    • indexPropertyName
    )
    UAVariable

    Defined in packages\node-opcua-address-space\src\extension_object_array_node.js:327

    Parameters:

    • uaArrayVariableNode UAVariable
    • variableType DataType
    • indexPropertyName String

    Returns:

    UAVariable:

    checkSelectClause

    (
    • parentNode
    • selectClause
    )
    Array

    Defined in packages\node-opcua-address-space\src\check_event_clause.js:8

    Parameters:

    • parentNode Object
    • selectClause Object

    Returns:

    Array:

    checkSelectClauses

    (
    • eventTypeNode
    • selectClauses
    )
    StatusCodes<>

    Defined in packages\node-opcua-address-space\src\check_event_clause.js:37

    Parameters:

    • eventTypeNode Object
    • selectClauses SelectClauseResults

    Returns:

    StatusCodes<>:

    createDataType

    (
    • options
    )

    Defined in packages\node-opcua-address-space\src\namespace.js:764

    Parameters:

    • options Object
      • isAbstract
      • browseName BrowseName
      • superType NodeId
      • [nodeId] optional
      • [displayName] optional
      • [description] optional

    createExtObjArrayNode

    (
    • parentFolder
    • options
    )
    Object | UAVariable

    Defined in packages\node-opcua-address-space\src\extension_object_array_node.js:245

    create a node Variable that contains a array of ExtensionObject of a given type

    Parameters:

    • parentFolder Object
    • options Object
      • browseName
      • complexVariableType
      • variableType

        the type of Extension objects stored in the array.

      • indexPropertyName

    Returns:

    Object | UAVariable:

    createNode

    (
    • options
    )

    Defined in packages\node-opcua-address-space\src\namespace.js:940

    Parameters:

    • options Object
      • nodeClass
      • [nodeVersion= "0"] String optional

        install nodeVersion

      • [modellingRule= null] String optional

    deleteNode

    (
    • nodeOrNodeId
    )

    Defined in packages\node-opcua-address-space\src\namespace.js:989

    remove the specified Node from the address space

    Parameters:

    • nodeOrNodeId Object

    findReferenceTypeFromInverseName

    (
    • inverseName
    )
    ReferenceType

    Defined in packages\node-opcua-address-space\src\namespace.js:168

    find a ReferenceType by its inverse name.

    Parameters:

    • inverseName String

      the inverse name of the ReferenceType to find

    Returns:

    ReferenceType:

    makeOptionalsMap

    (
    • optionals transform
    )

    Defined in packages\node-opcua-address-space\src\make_optionals_map.js:4

    Parameters:

    • optionals transform Object

      optional into a map

    prepareDataType

    (
    • dataType
    )
    private

    Defined in packages\node-opcua-address-space\src\extension_object_array_node.js:311

    Parameters:

    • dataType Object

    removeElement

    (
    • uaArrayVariableNode
    • elementIndex
    • uaArrayVariableNode
    • element
    )

    Defined in packages\node-opcua-address-space\src\extension_object_array_node.js:497

    Parameters:

    • uaArrayVariableNode UAVariable
    • elementIndex Number

      index of element to remove in array

    • uaArrayVariableNode UAVariable
    • element UAVariable

      node of element to remove in array

    toString

    () String

    Defined in packages\node-opcua-address-space\src\reference.js:69

    turn reference into a arrow : ---- REFERENCETYPE --> [NODEID]

    Returns:

    String: