ClientMonitoredItem | NodeOPCUA reference documentation

Hierarchy

ClientMonitoredItemBase
ClientMonitoredItemOrGroupAction
EventEmitter
- ClientMonitoredItem

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ClientMonitoredItem(): ClientMonitoredItem

Returns ClientMonitoredItem

Properties

Optional filterResult

filterResult: ExtensionObject

itemToMonitor

itemToMonitor: ReadValueId

Optional monitoredItemId

monitoredItemId: any

monitoringMode

monitoringMode: MonitoringMode

monitoringParameters

monitoringParameters: MonitoringParameters

Optional result

result: MonitoredItemCreateResult

statusCode

statusCode: StatusCode

subscription

subscription: ClientSubscription

Methods

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): ClientMonitoredItem

Inherited from ClientMonitoredItemBase.addListener
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientMonitoredItem

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from ClientMonitoredItemBase.emit
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from ClientMonitoredItemBase.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

Inherited from ClientMonitoredItemBase.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

listenerCount

listenerCount(event: string | symbol): number

Inherited from ClientMonitoredItemBase.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from ClientMonitoredItemBase.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

modify

modify(parameters: MonitoringParametersOptions, timestampsToReturn?: TimestampsToReturn): Promise<StatusCode>
modify(parameters: MonitoringParametersOptions, callback: Callback<StatusCode>): void
modify(parameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn, callback: Callback<StatusCode>): void

Inherited from ClientMonitoredItemOrGroupAction.modify
- Defined in packages/node-opcua-client/dist/client_monitored_item_base.d.ts:15
Parameters
- parameters: MonitoringParametersOptions
- Optional timestampsToReturn: TimestampsToReturn
Returns Promise<StatusCode>
Inherited from ClientMonitoredItemOrGroupAction.modify
- Defined in packages/node-opcua-client/dist/client_monitored_item_base.d.ts:16
Parameters
- parameters: MonitoringParametersOptions
- callback: Callback<StatusCode>
Returns void
Inherited from ClientMonitoredItemOrGroupAction.modify
- Defined in packages/node-opcua-client/dist/client_monitored_item_base.d.ts:17
Parameters
- parameters: MonitoringParametersOptions
- timestampsToReturn: TimestampsToReturn
- callback: Callback<StatusCode>
Returns void

off

off(event: string | symbol, listener: (...args: any[]) => void): ClientMonitoredItem

Inherited from ClientMonitoredItemBase.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientMonitoredItem

on

on(event: "changed", eventHandler: (dataValue: DataValue) => void): ClientMonitoredItem
on(event: "changed", eventHandler: (values: Variant[]) => void): ClientMonitoredItem
on(event: "terminated", eventHandler: () => void): ClientMonitoredItem
on(event: "initialized", eventHandler: () => void): ClientMonitoredItem
on(event: "err", eventHandler: (message: string) => void): ClientMonitoredItem

Overrides ClientMonitoredItemBase.on
- Defined in packages/node-opcua-client/dist/client_monitored_item.d.ts:13
Parameters
- event: "changed"
- eventHandler: (dataValue: DataValue) => void
  - - (dataValue: DataValue): void
    - Parameters
      - dataValue: DataValue
      Returns void
Returns ClientMonitoredItem
Overrides ClientMonitoredItemBase.on
- Defined in packages/node-opcua-client/dist/client_monitored_item.d.ts:14
Parameters
- event: "changed"
- eventHandler: (values: Variant[]) => void
  - - (values: Variant[]): void
    - Parameters
      - values: Variant[]
      Returns void
Returns ClientMonitoredItem
Overrides ClientMonitoredItemBase.on
- Defined in packages/node-opcua-client/dist/client_monitored_item.d.ts:15
Parameters
- event: "terminated"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns ClientMonitoredItem
Overrides ClientMonitoredItemBase.on
- Defined in packages/node-opcua-client/dist/client_monitored_item.d.ts:16
Parameters
- event: "initialized"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns ClientMonitoredItem
Overrides ClientMonitoredItemBase.on
- Defined in packages/node-opcua-client/dist/client_monitored_item.d.ts:17
Parameters
- event: "err"
- eventHandler: (message: string) => void
  - - (message: string): void
    - Parameters
      - message: string
      Returns void
Returns ClientMonitoredItem

once

once(event: string | symbol, listener: (...args: any[]) => void): ClientMonitoredItem

Inherited from ClientMonitoredItemBase.once
- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientMonitoredItem

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): ClientMonitoredItem

Inherited from ClientMonitoredItemBase.prependListener
- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientMonitoredItem

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): ClientMonitoredItem

Inherited from ClientMonitoredItemBase.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientMonitoredItem

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from ClientMonitoredItemBase.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): ClientMonitoredItem

Inherited from ClientMonitoredItemBase.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns ClientMonitoredItem

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): ClientMonitoredItem

Inherited from ClientMonitoredItemBase.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientMonitoredItem

setMaxListeners

setMaxListeners(n: number): ClientMonitoredItem

Inherited from ClientMonitoredItemBase.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns ClientMonitoredItem

setMonitoringMode

setMonitoringMode(monitoringMode: MonitoringMode): Promise<StatusCode>
setMonitoringMode(monitoringMode: MonitoringMode, callback: Callback<StatusCode>): void

Inherited from ClientMonitoredItemOrGroupAction.setMonitoringMode
- Defined in packages/node-opcua-client/dist/client_monitored_item_base.d.ts:18
Parameters
- monitoringMode: MonitoringMode
Returns Promise<StatusCode>
Inherited from ClientMonitoredItemOrGroupAction.setMonitoringMode
- Defined in packages/node-opcua-client/dist/client_monitored_item_base.d.ts:19
Parameters
- monitoringMode: MonitoringMode
- callback: Callback<StatusCode>
Returns void

terminate

terminate(): Promise<void>
terminate(done: ErrorCallback): void

Inherited from ClientMonitoredItemOrGroupAction.terminate
- Defined in packages/node-opcua-client/dist/client_monitored_item_base.d.ts:20
Returns Promise<void>
Inherited from ClientMonitoredItemOrGroupAction.terminate
- Defined in packages/node-opcua-client/dist/client_monitored_item_base.d.ts:21
Parameters
- done: ErrorCallback
Returns void

Static create

create(subscription: ClientSubscription, itemToMonitor: ReadValueIdOptions, monitoringParameters: MonitoringParametersOptions, timestampsToReturn?: TimestampsToReturn): ClientMonitoredItem

- Defined in packages/node-opcua-client/dist/client_monitored_item.d.ts:20
Parameters
- subscription: ClientSubscription
- itemToMonitor: ReadValueIdOptions
- monitoringParameters: MonitoringParametersOptions
- Optional timestampsToReturn: TimestampsToReturn
Returns ClientMonitoredItem

subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ClientMonitoredItem

Properties

Optional filterResult

itemToMonitor

Optional monitoredItemId

monitoringMode

monitoringParameters

Optional result

statusCode

subscription

Methods

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns ClientMonitoredItem

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

modify

Parameters

parameters: MonitoringParametersOptions

Optional timestampsToReturn: TimestampsToReturn

Returns Promise<StatusCode>

Parameters

parameters: MonitoringParametersOptions

callback: Callback<StatusCode>

Returns void

Parameters

parameters: MonitoringParametersOptions

timestampsToReturn: TimestampsToReturn

callback: Callback<StatusCode>

Returns void

off

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns ClientMonitoredItem

on

Parameters

event: "changed"

eventHandler: (dataValue: DataValue) => void

Parameters

dataValue: DataValue

Returns void

Returns ClientMonitoredItem

Parameters

event: "changed"

eventHandler: (values: Variant[]) => void

Parameters

values: Variant[]

Returns void