API Docs for: 0.0.57
Show:

QueryDataDescription Class

Constructor

QueryDataDescription

(
  • options
)

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
Calculate the required size to store this object in a binary stream.

Returns:

Number:

decode_debug

()

encode

(
  • stream
)

encode the object into a binary stream

Parameters:

isValid

() Boolean
verify that all object attributes values are valid according to schema

Returns:

Boolean:

toString

() String

Returns:

String:

Properties

attributeId

IntegerId

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

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

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.