The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    BrowseDescription Class

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

    A request to browse the the references from a node.

    Constructor

    BrowseDescription

    (
    • options
    )

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

    Parameters:

    • options Object
      • [nodeId] NodeId optional

        The id of the node to browse.

      • [browseDirection] BrowseDirection optional

        The direction of the references to return.

      • [referenceTypeId] NodeId optional

        The type of references to return.Specifies the NodeId of the ReferenceType to follow. Only instances of this ReferenceType or its subtype are returned.If not specified then all ReferenceTypes are returned and includeSubtypes is ignored.

      • [includeSubtypes] Boolean optional

        Includes subtypes of the reference type.

      • [nodeClassMask] UInt32 optional

        A mask indicating which node classes to return. 0 means return all nodes.

      • [resultMask= 0] UInt32 optional

        A mask indicating which fields in the ReferenceDescription should be returned in the results.

    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_BrowseDescription.js:136

    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_BrowseDescription.js:120

    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

    browseDirection

    BrowseDirection

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-browse\_generated_\_auto_generated_BrowseDescription.js:59

    The direction of the references to return.

    includeSubtypes

    Boolean

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-browse\_generated_\_auto_generated_BrowseDescription.js:73

    Includes subtypes of the reference type.

    nodeClassMask

    UInt32

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-browse\_generated_\_auto_generated_BrowseDescription.js:80

    A mask indicating which node classes to return. 0 means return all nodes.

    referenceTypeId

    NodeId

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-browse\_generated_\_auto_generated_BrowseDescription.js:66

    The type of references to return.Specifies the NodeId of the ReferenceType to follow. Only instances of this ReferenceType or its subtype are returned.If not specified then all ReferenceTypes are returned and includeSubtypes is ignored.

    resultMask

    UInt32

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-browse\_generated_\_auto_generated_BrowseDescription.js:87

    A mask indicating which fields in the ReferenceDescription should be returned in the results.

    Default: 0