The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    QueryDataDescription Class

    Extends BaseUAObject
    Defined in: packages\node-opcua-service-query\_generated_\_auto_generated_QueryDataDescription.js:28
    Module: opcua.address_space.types

    Constructor

    QueryDataDescription

    (
    • options
    )

    Defined in packages\node-opcua-service-query\_generated_\_auto_generated_QueryDataDescription.js:28

    Parameters:

    • options Object
      • [relativePath] RelativePath optional

        Browse path relative to the originating Node that identifies the Node which contains the data that is being requested, where the originating Node is an instance Node of the type defined by the type definition Node. The instance Nodes are further limited by the filter provided as part of this call.

      • [attributeId] IntegerId optional

        Id of the Attribute. This shall be a valid Attribute Id. The IntegerId is defined in 7.14. The IntegerId for Attributes are defined in Part 6. If the RelativePath ended in a Reference then this parameter is 0 and ignored by the server.

      • [indexRange] NumericRange optional

        This parameter is used to identify a single element of a structure or an array, or a single range of indexes for arrays. If a range of elements are specified, the values are returned as a composite. The first element is identified by index 0 (zero).

    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-query\_generated_\_auto_generated_QueryDataDescription.js:94

    decode the object from a binary stream

    Parameters:

    encode

    (
    • stream
    )

    Defined in packages\node-opcua-service-query\_generated_\_auto_generated_QueryDataDescription.js:81

    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

    attributeId

    IntegerId

    Defined in packages\node-opcua-service-query\_generated_\_auto_generated_QueryDataDescription.js:56

    Id of the Attribute. This shall be a valid Attribute Id. The IntegerId is defined in 7.14. The IntegerId for Attributes are defined in Part 6. If the RelativePath ended in a Reference then this parameter is 0 and ignored by the server.

    indexRange

    NumericRange

    Defined in packages\node-opcua-service-query\_generated_\_auto_generated_QueryDataDescription.js:63

    This parameter is used to identify a single element of a structure or an array, or a single range of indexes for arrays. If a range of elements are specified, the values are returned as a composite. The first element is identified by index 0 (zero).

    relativePath

    RelativePath

    Defined in packages\node-opcua-service-query\_generated_\_auto_generated_QueryDataDescription.js:49

    Browse path relative to the originating Node that identifies the Node which contains the data that is being requested, where the originating Node is an instance Node of the type defined by the type definition Node. The instance Nodes are further limited by the filter provided as part of this call.