The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    ReferenceDescription Class

    Extends BaseUAObject
    Defined in: packages\node-opcua-service-browse\index.js:13
    Module: services.browse

    The description of a reference.

    Constructor

    ReferenceDescription

    (
    • options
    )

    Defined in packages\node-opcua-service-browse\index.js:13

    Parameters:

    • options Object
      • [referenceTypeId] NodeId optional

        The type of references.

      • [isForward] Boolean optional

        TRUE if the reference is a forward reference.

      • [nodeId] ExpandedNodeId optional

        The id of the target node.

      • [browseName] QualifiedName optional

        The browse name of the target node.

      • [displayName] LocalizedText optional

        The display name of the target node.

      • [nodeClass= 0] NodeClass optional

        The node class of the target node.

      • [typeDefinition] ExpandedNodeId optional

        The type definition of the target node.

    Methods

    binaryStoreSize

    () Number

    Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:49

    Calculate the required size to store this object in a binary stream.

    Returns:

    Number:

    decode

    (
    • stream
    • [option]
    )

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-browse\_generated_\_auto_generated_ReferenceDescription.js:147

    decode the object from a binary stream

    Parameters:

    encode

    (
    • stream
    )

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-browse\_generated_\_auto_generated_ReferenceDescription.js:130

    encode the object into a binary stream

    Parameters:

    isValid

    () Boolean

    Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:83

    verify that all object attributes values are valid according to schema

    Returns:

    Boolean:

    toString

    () String

    Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:61

    Returns:

    String:

    Properties

    browseName

    QualifiedName

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-browse\_generated_\_auto_generated_ReferenceDescription.js:76

    The browse name of the target node.

    displayName

    LocalizedText

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-browse\_generated_\_auto_generated_ReferenceDescription.js:83

    The display name of the target node.

    isForward

    Boolean

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-browse\_generated_\_auto_generated_ReferenceDescription.js:62

    TRUE if the reference is a forward reference.

    nodeClass

    NodeClass

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-browse\_generated_\_auto_generated_ReferenceDescription.js:90

    The node class of the target node.

    Default: 0

    typeDefinition

    ExpandedNodeId

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-browse\_generated_\_auto_generated_ReferenceDescription.js:98

    The type definition of the target node.