Currentoptions, Defaultoptions, E currentoptions – Echelon OpenLNS User Manual

Page 535

Advertising
background image

OpenLNS Programmer's Reference

498

CurrentOptions

Summary

Contains the current monitoring options for this message

monitor point. Once the monitor set containing a monitor

point has been opened, you can use this property to set the

monitoring options that will be used for the monitor point

during that particular session

.

For monitor points in

MonitorSet

objects created as

permanent monitor sets, the options contained in this

property default to the options set in the

DefaultOptions

property of the

MsgMonitorPoint

. If the options are not set

there, they default to the options set in the

MsgOptions

and

NvOptions

properties in the

MonitorSet

object.

Each time a permanent

MonitorSet

object’s

Open

method is

called, the current options for each of the monitor points in

the set are reset to the options contained in their

CurrentOptions

properties. The

CurrentOptions

property can

only be written to when the monitor set is open.
The

MsgMonitorOptions

object contained within this

property is not passed by reference. If you acquire a

MsgMonitorOptions

object through the

CurrentOptions

property and modify it, you must then explicitly assign the

modified object back to the

CurrentOptions

property for the

changes to take effect. This following code sample

demonstrates this procedure:

Set curOptions = monPoint.CurrentOptions

curOptions.Authentication = True

curOptions.Retries = 5

Set monPoint.CurrentOptions = curOptions

Availability

Local, full, lightweight, and independent clients. Note that

temporary

MonitorSet

objects and temporary monitor points

are not available on Independent clients.

Syntax

curOptions = monPoint.

CurrentOptions

Element

Description

curOptions

The

MsgMonitorOptions

object

containing the current options for this

monitor point.

monPoint

The

MsgMonitorPoint

object to be acted

on.

Data Type

MsgMonitorOptions

object.

Read/Write

Read/write.

Added to API

LNS Release 3.0.

DefaultOptions

Summary

Contains the default monitoring options that are applied

each time the monitor set containing this network variable or

Advertising