Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientMonitoredItem

Hierarchy

Implemented by

Index

Properties

Methods

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

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

emit

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

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

modify

  • modify(parameters: MonitoringParametersOptions): Promise<StatusCode>
  • modify(parameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn): Promise<StatusCode>
  • modify(parameters: MonitoringParametersOptions, callback: Callback<StatusCode>): void
  • modify(parameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn | null, callback: Callback<StatusCode>): void
  • modify(...args: any[]): any

off

  • off(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: "changed", eventHandler: function): this
  • on(event: "changed", eventHandler: function): this
  • on(event: "terminated", eventHandler: function): this
  • on(event: "initialized", eventHandler: function): this
  • on(event: "err", eventHandler: function): this

once

  • once(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

setMonitoringMode

  • setMonitoringMode(monitoringMode: MonitoringMode): Promise<StatusCode>
  • setMonitoringMode(monitoringMode: MonitoringMode, callback: Callback<StatusCode>): void
  • setMonitoringMode(...args: any[]): any

terminate

  • terminate(): Promise<void>
  • terminate(done: ErrorCallback): void
  • terminate(...args: any[]): any

Static create

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

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc