The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    MonitoredItem Class

    Defined in: packages\node-opcua-server\src\monitored_item.js:69
    Module: opcua.server

    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
    )

    Defined in packages\node-opcua-server\src\monitored_item.js:69

    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

    Defined in packages\node-opcua-server\src\monitored_item.js:404

    extractMonitoredItemNotifications

    () Array.<>

    Defined in packages\node-opcua-server\src\monitored_item.js:785

    Returns:

    Array.<>:

    recordValue

    (
    • dataValue
    • skipChangeTest
    )

    Defined in packages\node-opcua-server\src\monitored_item.js:594

    Parameters:

    • dataValue DataValue

      the whole dataValue

    • skipChangeTest Boolean

      Note: recordValue can only be called within timer event

    terminate This will stop the internal sampling timer.

    ()

    Defined in packages\node-opcua-server\src\monitored_item.js:393

    Terminate the MonitoredItem.

    Properties

    node the associated node object in the address space

    BaseNode | Null

    Defined in packages\node-opcua-server\src\monitored_item.js:120