API Docs for: 0.0.57
Show:

Argument Class

An argument for a method.

Constructor

Argument

(
  • options
)

Parameters:

  • options Object
    • [name] String optional

      The name of the argument.

    • [dataType] NodeId optional

      The nodeId of the Data type of the argument.

    • [valueRank= -1] Int32 optional

      Whether the argument is an array type and the rank of the array if it is.

    • [arrayDimensions= null] UInt32 optional

      The number of dimensions if the argument is an array type and one or more dimensions have a fixed length.

    • [description] LocalizedText optional

      The description for the argument.

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:

encodeMessage

()

Defined in lib\nodeopcua.js:39

isValid

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

Returns:

Boolean:

perform_findServersRequest

(
  • discovery_server_endpointUrl
  • callback
)
async

extract the server endpoints exposed by a discovery server

Parameters:

  • discovery_server_endpointUrl Object
  • callback Object

toString

() String

Returns:

String:

Properties

arrayDimensions

UInt32

The number of dimensions if the argument is an array type and one or more dimensions have a fixed length.

Default: null

arrayDimensions !~YUIDOC_LINE~!This Attribute specifies the length of each dimension for an array!~YUIDOC_LINE~!value. The Attribute is intended to describe the capability of the!~YUIDOC_LINE~!Variable, not the current size.!~YUIDOC_LINE~!The number of elements shall be equal to the value of the ValueRank!~YUIDOC_LINE~!Attribute. Shall be null if ValueRank ≤0.!~YUIDOC_LINE~!A value of 0 for an individual dimension indicates that the dimension!~YUIDOC_LINE~!has a variable length.!~YUIDOC_LINE~!For example, if a Variable is defined by the following C array:!~YUIDOC_LINE~!Int32 myArray[346];!~YUIDOC_LINE~!then this Variable’s DataType would point to an Int32, the Variable’s!~YUIDOC_LINE~!ValueRank has the value 1 and the one entry having the value 346.

UInt32

dataType

NodeId

The nodeId of the Data type of the argument.

description

LocalizedText

The description for the argument.

name

String

The name of the argument.

valueRank

Int32

Whether the argument is an array type and the rank of the array if it is.

Default: -1