Echelon OpenLNS - Manual (Page 501)

OpenLNS Programmer's Reference 464
Data Type Object.
Read/Write Read only.
Added to API OpenLNS.
MonitorSet
A MonitorSet object represents a set of network variable and message tag monitor points.
You can use this object to maintain and monitor all of the monitor points it contains as a
group (points can also be controlled individually). This object also contains the default
settings that are applied to all monitor points as they are added to the set.
There are two separate types of MonitorSet objects: permanent MonitorSet objects, which can
be used in multiple client sessions, and temporary MonitorSet objects, which can only be
used in a single client session. The rest of this section describes how you can access each type
of MonitorSet object, and when you will want to use each type.
Each
Network object contains a MyVNI property, which returns an AppDevice object
representing the network service device (NSD) of a client computer on the network. You can
use this AppDevice object to access all the MonitorSet objects that are stored in the OpenLNS
database for your client computer’s NSD. Echelon recommends that you only use the MyVNI
property to access MonitorSet objects when you need to create MonitorSet objects, or when
you need to modify the configuration of those MonitorSet objects. For actual monitor and
control operations, you should use the CurrentMonitorSets property of the Network object.
The CurrentMonitorSets property returns a collection of all the MonitorSet objects on a
network that are currently stored in your client’s NSD. This may be useful if you have
created monitor sets while the network management mode is set to
lcaMgmtModeDeferConfigUpdates (1). Although those monitor sets exist in the
OpenLNS database and can be accessed through the MyVNI property mentioned in the
previous paragraph, they will not be commissioned into the NSD, and cannot be enabled or
used for monitor and control operations, until the network management mode is set to
lcaMgmtModePropagateConfigUpdates (0) and the NSD is updated. The collection
accessed through the CurrentMonitorSets property allows access to all the monitor sets you
can currently use on a network (the collection accessed through the MyVNI property allows
access to these monitor sets, as well as those that have not yet been commissioned into your
client computer’s NSD). You can use all the monitor sets obtained through the
CurrentMonitorSets property as runtime monitor sets, meaning that you can enable them
and use them for monitoring operations. However, changes to their configuration are not
allowed when accessed through this collection. As noted previously, you should use the
collection obtained through the MyVNI property when you need to write to the configuration
of your client’s local MonitorSet objects.
You should use the permanent
MonitorSet objects accessed through the MyVNI and
CurrentMonitorSets properties when you need to create monitor points that will be used in
multiple client sessions.
If you need monitor points that will only be used in a single client session, you should use
temporary MonitorSet objects. You can create a temporary monitor sets with the
CreateTemporaryMonitorSet method. Temporary monitor sets are opened automatically by
OpenLNS as they are created, and they can only be accessed from the client that created
them. They cannot be accessed from the permanent MonitorSets collections described above.
When a client releases a temporary monitor set, or when the client session in which a
temporary monitor set was created ends, the temporary monitor set and all the monitor
points it contains are deleted. If you need to create a group of monitor points that you can