APIs

Show:

Constructor

Variant

(
  • options
)

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

add a subscriber to the WatchDog.

Parameters:

  • subscriber Object
  • timeout Object

Returns:

Number:

binaryStoreSize

() Number

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

Returns:

exports.Variant:

decode

(
  • stream
  • [option]
)

decode the object from a binary stream

Parameters:

encodeMessage

()

getObjectClassName

(
  • obj
)
String

Parameters:

  • obj Object

Returns:

String:

isValid

() Boolean

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

Returns:

String:

Properties

arrayType

VariantArrayType

Default: 0

dataType

DataType

the variant type.

Default: 0

dimensions

UInt32

the matrix dimensions

Default: null

subscriberCount

Number

returns the number of subscribers using the WatchDog object.