The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    RelativePathElement Class

    Extends BaseUAObject
    Defined in: packages\node-opcua-service-translate-browse-path\_generated_\_auto_generated_RelativePathElement.js:28
    Module: opcua.address_space.types

    An element in a relative path.

    Constructor

    RelativePathElement

    (
    • options
    )

    Defined in packages\node-opcua-service-translate-browse-path\_generated_\_auto_generated_RelativePathElement.js:28

    Parameters:

    • options Object
      • [referenceTypeId] NodeId optional

        The type of reference to follow.

      • [isInverse] Boolean optional

        If TRUE the reverse reference is followed.

      • [includeSubtypes] Boolean optional

        If TRUE then subtypes of the reference type are followed.

      • [targetName] QualifiedName optional

        The browse name of the target.

    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]
    )

    Defined in packages\node-opcua-service-translate-browse-path\_generated_\_auto_generated_RelativePathElement.js:104

    decode the object from a binary stream

    Parameters:

    encode

    (
    • stream
    )

    Defined in packages\node-opcua-service-translate-browse-path\_generated_\_auto_generated_RelativePathElement.js:90

    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

    includeSubtypes

    Boolean

    Defined in packages\node-opcua-service-translate-browse-path\_generated_\_auto_generated_RelativePathElement.js:65

    If TRUE then subtypes of the reference type are followed.

    isInverse

    Boolean

    Defined in packages\node-opcua-service-translate-browse-path\_generated_\_auto_generated_RelativePathElement.js:58

    If TRUE the reverse reference is followed.