MonitoredItem | NodeOPCUA reference documentation

a server side monitored item

Once created, the MonitoredItem will raised an "samplingEvent" event every "samplingInterval" millisecond until {{#crossLink "MonitoredItem/terminate:method"}}{{/crossLink}} is called.
It is up to the event receiver to call {{#crossLink "MonitoredItem/recordValue:method"}}{{/crossLink}}.

Hierarchy

EventEmitter
- MonitoredItem

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new MonitoredItem(options: MonitoredItemOptions): MonitoredItem

Overrides EventEmitter.constructor
- Defined in node-opcua-server/dist/monitored_item.d.ts:101
Parameters
- options: MonitoredItemOptions
Returns MonitoredItem

Properties

Optional $subscription

$subscription: ISubscription

Optional _samplingId

_samplingId: string | Timer

clientHandle

clientHandle: number

discardOldest

discardOldest: boolean

filter

filter: MonitoringFilter

itemToMonitor

itemToMonitor: any

monitoredItemId

monitoredItemId: number

monitoringMode

monitoringMode: MonitoringMode

Optional oldDataValue

oldDataValue: DataValue

overflow

overflow: boolean

queueSize

queueSize: number

samplingFunc

samplingFunc: (value: DataValue, callback: (err: Error, dataValue?: DataValue) => void) => void

Type declaration

- (value: DataValue, callback: (err: Error, dataValue?: DataValue) => void): void
- Parameters
  - value: DataValue
  - callback: (err: Error, dataValue?: DataValue) => void
    - - (err: Error, dataValue?: DataValue): void
      - Parameters
        
        err: Error
        
        Optional dataValue: DataValue
        
        Returns void
  Returns void

samplingInterval

samplingInterval: number

timestampsToReturn

timestampsToReturn: TimestampsToReturn

Static defaultSamplingInterval

defaultSamplingInterval: number

Static maximumSamplingInterval

maximumSamplingInterval: number

Static minimumSamplingInterval

minimumSamplingInterval: number

Static registry

registry: ObjectRegistry

Accessors

hasMonitoredItemNotifications

get hasMonitoredItemNotifications(): boolean

- Defined in node-opcua-server/dist/monitored_item.d.ts:135
Returns boolean

isSampling

get isSampling(): boolean

- Defined in node-opcua-server/dist/monitored_item.d.ts:112
Returns boolean

node

get node(): BaseNode
set node(someNode: BaseNode): void

- Defined in node-opcua-server/dist/monitored_item.d.ts:70
Returns BaseNode
- Defined in node-opcua-server/dist/monitored_item.d.ts:71
Parameters
- someNode: BaseNode
Returns void

Methods

addLinkItem

addLinkItem(linkedMonitoredItemId: number): StatusCode

- Defined in node-opcua-server/dist/monitored_item.d.ts:129
Parameters
- linkedMonitoredItemId: number
Returns StatusCode

dispose

dispose(): void

- Defined in node-opcua-server/dist/monitored_item.d.ts:111
Returns void

extractMonitoredItemNotifications

extractMonitoredItemNotifications(bForce?: boolean): QueueItem[]

- Defined in node-opcua-server/dist/monitored_item.d.ts:140
Parameters
- Optional bForce: boolean
Returns QueueItem[]

hasLinkItem

hasLinkItem(linkedMonitoredItemId: number): boolean

- Defined in node-opcua-server/dist/monitored_item.d.ts:128
Parameters
- linkedMonitoredItemId: number
Returns boolean

modify

modify(timestampsToReturn: TimestampsToReturn, monitoringParameters: MonitoringParameters): MonitoredItemModifyResult

- Defined in node-opcua-server/dist/monitored_item.d.ts:141
Parameters
- timestampsToReturn: TimestampsToReturn
- monitoringParameters: MonitoringParameters
Returns MonitoredItemModifyResult

removeLinkItem

removeLinkItem(linkedMonitoredItemId: number): StatusCode

- Defined in node-opcua-server/dist/monitored_item.d.ts:130
Parameters
- linkedMonitoredItemId: number
Returns StatusCode

resendInitialValues

resendInitialValues(): Promise<void>

- Defined in node-opcua-server/dist/monitored_item.d.ts:142
Returns Promise<void>

setMonitoringMode

setMonitoringMode(monitoringMode: MonitoringMode): void

- Defined in node-opcua-server/dist/monitored_item.d.ts:103
Parameters
- monitoringMode: MonitoringMode
Returns void

setNode

setNode(node: BaseNode): void

- Defined in node-opcua-server/dist/monitored_item.d.ts:102
Parameters
- node: BaseNode
Returns void

terminate

terminate(): void

- Defined in node-opcua-server/dist/monitored_item.d.ts:110
Terminate the MonitoredItem.

method

terminate

This will stop the internal sampling timer.

Returns void

toString

toString(): string

- Defined in node-opcua-server/dist/monitored_item.d.ts:113
Returns string

subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: MonitoredItemOptions

Returns MonitoredItem

Properties

Optional $subscription

Optional _samplingId

clientHandle

discardOldest

filter

itemToMonitor

monitoredItemId

monitoringMode

Optional oldDataValue

overflow

queueSize

samplingFunc

Type declaration

Parameters

value: DataValue

callback: (err: Error, dataValue?: DataValue) => void

Parameters

err: Error

Optional dataValue: DataValue

Returns void

Returns void

samplingInterval

timestampsToReturn

Static defaultSamplingInterval

Static maximumSamplingInterval

Static minimumSamplingInterval

Static registry

Accessors

hasMonitoredItemNotifications

Returns boolean

isSampling

Returns boolean

node

Returns BaseNode

Parameters

someNode: BaseNode

Returns void

Methods

addLinkItem

Parameters

linkedMonitoredItemId: number

Returns StatusCode

dispose

Returns void

extractMonitoredItemNotifications

Parameters

Optional bForce: boolean

Returns QueueItem[]

hasLinkItem

Parameters

linkedMonitoredItemId: number

Returns boolean

modify

Parameters

timestampsToReturn: TimestampsToReturn

monitoringParameters: MonitoringParameters

Returns MonitoredItemModifyResult

removeLinkItem

Parameters

linkedMonitoredItemId: number

Returns StatusCode

resendInitialValues

Returns Promise<void>

setMonitoringMode

Parameters

monitoringMode: MonitoringMode

Returns void