The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    ReadRequest Class

    Extends BaseUAObject
    Defined in: packages\node-opcua-service-read\index.js:27
    Module: services.read

    Constructor

    ReadRequest

    (
    • options
    )

    Defined in packages\node-opcua-service-read\index.js:27

    Parameters:

    • options Object
      • [requestHeader] RequestHeader optional
      • [maxAge] Duration optional

        Maximum age of the value to be read in milliseconds

      • [timestampsToReturn= -1] TimestampsToReturn optional

        An enumeration that specifies the Timestamps to be returned for each requested Variable Value Attribute.

      • [nodesToRead] ReadValueId[] optional

        List of Nodes and their Attributes to read. For each entry in this list, a StatusCode is returned, and if it indicates success, the Attribute Value is also returned.

    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]
    )

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-read\_generated_\_auto_generated_ReadRequest.js:119

    decode the object from a binary stream

    Parameters:

    encode

    (
    • stream
    )

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-read\_generated_\_auto_generated_ReadRequest.js:105

    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

    maxAge

    Duration

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-read\_generated_\_auto_generated_ReadRequest.js:58

    Maximum age of the value to be read in milliseconds

    nodesToRead

    ReadValueId[]

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-read\_generated_\_auto_generated_ReadRequest.js:73

    List of Nodes and their Attributes to read. For each entry in this list, a StatusCode is returned, and if it indicates success, the Attribute Value is also returned.

    timestampsToReturn

    TimestampsToReturn

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-read\_generated_\_auto_generated_ReadRequest.js:65

    An enumeration that specifies the Timestamps to be returned for each requested Variable Value Attribute.

    Default: -1