NodeOPCUA API Documentation
    Preparing search index...

    Interface MonitoredItemOptions

    interface MonitoredItemOptions {
        clientHandle: number;
        discardOldest: boolean;
        filter: ExtensionObject | null;
        itemToMonitor?: ReadValueIdOptions;
        minSupportedSampleRate?: number;
        monitoredItemId: number;
        monitoringMode: MonitoringMode;
        queueSize: number;
        samplingInterval: number;
        timestampsToReturn?: TimestampsToReturn;
        get schema(): IStructuredTypeSchema;
        applyOnAllFields<T>(func: Func1<T>, data: T): void;
        binaryStoreSize(): number;
        clone(): IBaseUAObject;
        decode(stream: BinaryStream): void;
        decodeDebug(stream: BinaryStream, options: DecodeDebugOptions): void;
        encode(stream: OutputBinaryStream): void;
        explore(): string;
        isValid(): boolean;
        toJSON(...args: unknown[]): unknown;
        toString(...args: unknown[]): string;
    }

    Hierarchy (View Summary)

    Index
    clientHandle discardOldest filter itemToMonitor? minSupportedSampleRate? monitoredItemId monitoringMode queueSize samplingInterval timestampsToReturn?
    schema
    applyOnAllFields binaryStoreSize clone decode decodeDebug encode explore isValid toJSON toString
    clientHandle: number

    the client handle

    discardOldest: boolean

    if discardOldest === true, older items are removed from the queue when queue overflows

    filter: ExtensionObject | null
    itemToMonitor?: ReadValueIdOptions
    minSupportedSampleRate?: number

    the MinSupportedSampleRate the server advertises: the floor of the revised sampling interval when 0 is requested. Defaults to MonitoredItem.minimumSamplingInterval.

    monitoredItemId: number

    the monitoredItem Id assigned by the server to this monitoredItem.

    monitoringMode: MonitoringMode
    queueSize: number

    the size of the queue.

    samplingInterval: number

    the monitored item sampling interval ..

    timestampsToReturn?: TimestampsToReturn
    • get schema(): IStructuredTypeSchema

      Returns IStructuredTypeSchema

    • Type Parameters

      • T

      Parameters

      • func: Func1<T>
      • data: T

      Returns void

    • Calculate the required size to store this object in a binary stream.

      Returns number

    • Returns IBaseUAObject

    • Encode the object to the binary stream.

      Parameters

      • stream: OutputBinaryStream

      Returns void

    • Returns string

    • verify that all object attributes values are valid according to schema

      Returns boolean

    • Parameters

      • ...args: unknown[]

      Returns unknown

    • Parameters

      • ...args: unknown[]

      Returns string

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods