Msgmonitoroptions – Echelon OpenLNS User Manual

Page 520

Advertising
background image

OpenLNS Programmer's Reference

483

Data Type

Object.

Read/Write

Read only.

Added to API

OpenLNS.

MsgMonitorOptions

The

MsgMonitorOptions

object contains a set of monitoring options that can be applied to the

message monitor points that OpenLNS is monitoring. Depending on how this object is

accessed, writing to this it may affect the monitoring options used for an entire monitor set,

or for an individual message tag monitor point.
The

MsgMonitorOptions

object accessed through the

MsgOptions

property of a

MonitorSet

object contains the default monitoring options for the monitor set. These are the default

options applied to all

MsgMonitorPoint

objects as they are added to the monitor set.

You can change the defaults an individual

MsgMonitorPoint

uses by writing to the

MsgMonitorOptions

object accessed through the

DefaultOptions

property of that

MsgMonitorPoint

object. This object contains the default options that will be used each time

the monitor set containing that particular

MsgMonitorPoint

object is opened. Note that this

only applies to message monitor points in permanent monitor sets. The

CurrentOptions

properties of message monitor points in temporary monitor sets are not accessible, as

temporary monitor sets are only used in a singe client session.
You can change the monitoring options a

MsgMonitorPoint

object will use for an active

monitoring session by writing to the

MsgMonitorOptions

object accessed through the

MsgMonitorPoint

object’s

CurrentOptions

property. Changes made to the current options

take effect for the current session only, and are not stored persistently in memory.
Note that the

MsgMonitorOptions

object contained within the

MsgOptions

property of a

monitor set (or the

CurrentOptions

properties of a monitor point) is not passed by reference.

If you acquire a

MsgMonitorOptions

object through any of these properties and modify it, you

must then explicitly assign the modified object back to the source property for the changes to

take effect.

The following table summarizes the MsgMonitorOptions

object.

Description

A set of monitoring options that can be applied to the

message monitor points being monitored by OpenLNS.

Added to API

LNS Release 3.0.

Accessed Through

MonitorSets

object.

MsgMonitorPoint

object.

Default Property

None.

Methods

None.

Properties

Authentication

ClassId

FilterByCode

FilterBySource

FilterCode

Parent

Priority

Retries

ServiceType

Advertising