API Docs for: 0.0.57
Show:

MonitoredItem Class

a server side monitored item

  • Once created, the MonitoredItem will raised an "samplingEvent" event every "samplingInterval" millisecond until MonitoredItem/terminate:method is called.

  • It is up to the event receiver to call recordValue.

Constructor

MonitoredItem

(
  • options
)

Parameters:

  • options Object

    the options

    • clientHandle Number
      • the client handle
    • samplingInterval Number
      • the sampling Interval
    • filter ExtensionObject
    • discardOldest Boolean
      • if discardOldest === true, older items are removed from the queue when
    • queueSize Number
      • the size of the queue.
    • monitoredItemId Number

      the monitoredItem Id assigned by the server to this monitoredItem.

    • itemToMonitor
    • monitoringMode
    • timestampsToReturn

Methods

_on_sampling_timer

() private

extractMonitoredItemNotifications

() Array.<>

Returns:

Array.<>:

recordValue

(
  • dataValue
)

Parameters:

  • dataValue DataValue

    the whole dataValue

    Note: recordValue can only be called within timer event

terminate This will stop the internal sampling timer.

()

Terminate the MonitoredItem.

Properties

isSampling

Boolean

node the associated node object in the address space

BaseNode | Null