The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.4.5

    • 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

    Methods

    binaryStoreSize

    () Number

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

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

    Returns:

    Number:

    decode

    (
    • stream
    )

    Provided by the opcua.address_space.types module.

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

    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:129

    encode the object into a binary stream

    Parameters:

    isValid

    () Boolean

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

    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:58

    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:75

    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:82

    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:61

    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:89

    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:97

    The type definition of the target node.