The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.4.5

    • APIs

    Show:

    ExpandedNodeId Class

    Extends NodeId
    Defined in: packages\node-opcua-nodeid\src\expanded_nodeid.js:13
    Module: opcua.datamodel

    An ExpandedNodeId extends the NodeId structure.

    An ExpandedNodeId extends the NodeId structure by allowing the NamespaceUri to be explicitly specified instead of using the NamespaceIndex. The NamespaceUri is optional. If it is specified then the NamespaceIndex inside the NodeId shall be ignored.

    The ExpandedNodeId is encoded by first encoding a NodeId as described in Clause 5 .2.2.9 and then encoding NamespaceUri as a String.

    An instance of an ExpandedNodeId may still use the NamespaceIndex instead of the NamespaceUri. In this case, the NamespaceUri is not encoded in the stream. The presence of the NamespaceUri in the stream is indicated by setting the NamespaceUri flag in the encoding format byte for the NodeId.

    If the NamespaceUri is present then the encoder shall encode the NamespaceIndex as 0 in the stream when the NodeId portion is encoded. The unused NamespaceIndex is included in the stream for consistency,

    An ExpandedNodeId may also have a ServerIndex which is encoded as a UInt32 after the NamespaceUri. The ServerIndex flag in the NodeId encoding byte indicates whether the ServerIndex is present in the stream. The ServerIndex is omitted if it is equal to zero.

    Constructor

    ExpandedNodeId

    (
    • identifierType
    • value
    • namespace
    • namespaceUri
    • serverIndex
    )

    Defined in packages\node-opcua-nodeid\src\expanded_nodeid.js:13

    Parameters:

    • identifierType NodeIdType
      • the nodeID type
    • value Number | String | GUID | Buffer
      • the node id value. The type of Value depends on identifierType.
    • namespace Number
      • the index of the related namespace (optional , default value = 0 )
    • namespaceUri String | Null
      • NamespaceUri
    • serverIndex UInteger32 | Null
      • the server Index

    Methods

    isEmpty

    () Boolean

    Inherited from NodeId: packages\node-opcua-nodeid\src\nodeid.js:161

    Returns:

    Boolean: true if the NodeId is null or empty

    isValidGuid

    (
    • guid
    )
    Boolean

    Provided by the opcua.miscellaneous module.

    Defined in packages\node-opcua-guid\src\guid.js:5

    checks if provided string is a valid Guid a valid GUID has the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX when X is a hexadecimal digit

    Parameters:

    • guid String

    Returns:

    Boolean:

    return true if the string is a valid GUID.

    makeExpandedNodeId

    (
    • value
    • [namespace=0]
    )
    ExpandedNodeId

    Defined in packages\node-opcua-nodeid\src\expanded_nodeid.js:91

    Parameters:

    Returns:

    ExpandedNodeId:

    toJSON

    () String

    Inherited from NodeId but overwritten in packages\node-opcua-nodeid\src\expanded_nodeid.js:73

    convert nodeId to a JSON string. same as {@link NodeId#toString }

    Returns:

    String:

    toString

    () String

    Inherited from NodeId but overwritten in packages\node-opcua-nodeid\src\expanded_nodeid.js:56

    Returns:

    String:

    verify_registry_counts

    (
    • info
    )
    Boolean private

    Provided by the opcua.miscellaneous module.

    Defined in packages\node-opcua-leak-detector\src\resource_leak_detector.js:38

    Parameters:

    • info Object

    Returns:

    Boolean:

    Properties

    namespace

    Number

    Inherited from NodeId: packages\node-opcua-nodeid\src\nodeid.js:77