Interface MonitoredItemOptions

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

Hierarchy (view full)

Properties

clientHandle discardOldest filter itemToMonitor? monitoredItemId monitoringMode queueSize samplingInterval timestampsToReturn?

Accessors

schema

Methods

applyOnAllFields binaryStoreSize clone decode decodeDebug encode explore isValid toJSON toString

Properties

clientHandle

clientHandle: number

the client handle

discardOldest

discardOldest: boolean

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

filter

filter: null | ExtensionObject

OptionalitemToMonitor

itemToMonitor?: ReadValueIdOptions

monitoredItemId

monitoredItemId: number

the monitoredItem Id assigned by the server to this monitoredItem.

monitoringMode

monitoringMode: MonitoringMode

queueSize

queueSize: number

the size of the queue.

samplingInterval

samplingInterval: number

the monitored item sampling interval ..

OptionaltimestampsToReturn

timestampsToReturn?: TimestampsToReturn

Accessors

schema

  • get schema(): IStructuredTypeSchema

  • Returns IStructuredTypeSchema

Methods

applyOnAllFields

  • applyOnAllFields<T>(func, data): void

  • Type Parameters

    • T

    Parameters

    • func: Func1<T>
    • data: T

    Returns void

binaryStoreSize

  • binaryStoreSize(): number

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

    Returns number

clone

  • clone(): any

  • Returns any

decode

  • decode(stream): void

  • Decode the object from the binary stream.

    Parameters

    Returns void

decodeDebug

  • decodeDebug(stream, options): void

  • Parameters

    Returns void

encode

  • encode(stream): void

  • Encode the object to the binary stream.

    Parameters

    • stream: OutputBinaryStream

    Returns void

explore

  • explore(): string

  • Returns string

isValid

  • isValid(): boolean

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

    Returns boolean

toJSON

  • toJSON(): any

  • Returns any

toString

  • toString(...args): string

  • Parameters

    • Rest...args: any[]

    Returns string

Settings

Member Visibility

On This Page

Properties
Accessors
Methods