The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    Argument Class

    Extends BaseUAObject
    Defined in: packages\node-opcua-service-call\schemas\Argument_schema.js:61
    Module: opcua.address_space.types

    An argument for a method.

    Constructor

    Argument

    (
    • options
    )

    Defined in packages\node-opcua-service-call\schemas\Argument_schema.js:61

    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

    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-call\_generated_\_auto_generated_Argument.js:121

    decode the object from a binary stream

    Parameters:

    encode

    (
    • stream
    )

    Defined in packages\node-opcua-service-call\_generated_\_auto_generated_Argument.js:106

    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

    arrayDimensions

    UInt32

    Defined in packages\node-opcua-service-call\_generated_\_auto_generated_Argument.js:76

    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

    Defined in packages\node-opcua-service-call\schemas\Argument_schema.js:88

    dataType

    NodeId

    Defined in packages\node-opcua-service-call\_generated_\_auto_generated_Argument.js:61

    The nodeId of the Data type of the argument.

    description

    LocalizedText

    Defined in packages\node-opcua-service-call\_generated_\_auto_generated_Argument.js:84

    The description for the argument.

    name

    String

    Defined in packages\node-opcua-service-call\_generated_\_auto_generated_Argument.js:54

    The name of the argument.

    valueRank

    Int32

    Defined in packages\node-opcua-service-call\_generated_\_auto_generated_Argument.js:68

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

    Default: -1