The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    Variant Class

    Extends BaseUAObject
    Defined in: packages\node-opcua-variant\src\variant.js:15
    Module: opcua.datamodel

    Constructor

    Variant

    (
    • options
    )

    Defined in packages\node-opcua-variant\src\variant.js:15

    Parameters:

    • options Object
      • [dataType= 0] DataType optional

        the variant type.

      • [arrayType= 0] VariantArrayType optional
      • [value= null] Any optional
      • [dimensions= null] UInt32 optional

        the matrix dimensions

    Methods

    addSubscriber add a subscriber to the WatchDog. This method modifies the subscriber be adding a new method to it called 'keepAlive' The subscriber must also provide a "watchdogReset". watchdogReset will be called if the subscriber failed to call keepAlive withing the timeout period.

    (
    • subscriber
    • timeout
    )
    Number

    Provided by the opcua.transport module.

    Defined in packages\node-opcua-utils\src\watchdog.js:71

    add a subscriber to the WatchDog.

    Parameters:

    • subscriber Object
    • timeout Object

    Returns:

    Number:

    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:

    check_flag

    (
    • value
    • mask
    )
    Boolean

    Provided by the opcua.utils module.

    Defined in packages\node-opcua-utils\index.js:21

    check if a set of bits are set in the values

    Parameters:

    • value Object
    • mask Object

    Returns:

    Boolean:

    clone deep clone a variant

    () exports.Variant

    Defined in packages\node-opcua-variant\src\variant.js:30

    Returns:

    exports.Variant:

    decode

    (
    • stream
    • [option]
    )

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-variant\_generated_\_auto_generated_Variant.js:119

    decode the object from a binary stream

    Parameters:

    encodeMessage

    ()

    Provided by the opcua.transport module.

    Defined in packages\node-opcua-transport\src\tools.js:80

    getObjectClassName

    (
    • obj
    )
    String

    Provided by the opcua.transport module.

    Defined in packages\node-opcua-utils\src\object_classname.js:2

    Parameters:

    • obj Object

    Returns:

    String:

    isValid

    () Boolean

    Inherited from BaseUAObject but overwritten in packages\node-opcua-variant\_generated_\_auto_generated_Variant.js:132

    verify that all object attributes values are valid according to schema

    Returns:

    Boolean:

    normalize_require_file

    (
    • baseFolder
    • full_path_to_file
    )

    Provided by the opcua.utils module.

    Defined in packages\node-opcua-utils\index.js:39

    Parameters:

    • baseFolder Object
    • full_path_to_file Object

    Example:

    : normalize_require_file("/home/bob/folder1/","/home/bob/folder1/folder2/toto.js").should.eql("./folder2/toto");

    set_flag

    (
    • value
    • mask
    )
    Number

    Provided by the opcua.utils module.

    Defined in packages\node-opcua-utils\index.js:9

    set a flag

    Parameters:

    • value Object
    • mask Object

    Returns:

    Number:

    toString

    () String

    Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:61

    Returns:

    String:

    Properties

    arrayType

    VariantArrayType

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-variant\_generated_\_auto_generated_Variant.js:59

    Default: 0

    dataType

    DataType

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-variant\_generated_\_auto_generated_Variant.js:51

    the variant type.

    Default: 0

    dimensions

    UInt32

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-variant\_generated_\_auto_generated_Variant.js:75

    the matrix dimensions

    Default: null

    subscriberCount

    Number

    Provided by the opcua.transport module.

    Defined in packages\node-opcua-utils\src\watchdog.js:16

    returns the number of subscribers using the WatchDog object.