APIs

Show:

Constructor

AttributeOperand

(
  • options
)

Parameters:

  • options Object
    • [nodeId] NodeId optional

      NodeId of a Node from the type system.

    • [alias] String optional

      An optional parameter used to identify or refer to an alias. An alias is a symbolic name that can be used to alias this operand and use it in other locations in the filter structure.

    • [browsePath] RelativePath optional

      Browse path relative to the Node identified by the nodeId parameter.

    • [attributeId] IntegerId optional
    • [indexRange] NumericRange optional

      This parameter is used to identify a single element of an array or a single range of indexes for an array. 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

(
  • stream
  • [option]
)

decode the object from a binary stream

Parameters:

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

alias

String

An optional parameter used to identify or refer to an alias. An alias is a symbolic name that can be used to alias this operand and use it in other locations in the filter structure.

browsePath

RelativePath

Browse path relative to the Node identified by the nodeId parameter.

indexRange

NumericRange

This parameter is used to identify a single element of an array or a single range of indexes for an array. The first element is identified by index 0 (zero).