The AMV API is implemented as a set of C++ classes which encapsulate various aspects of the connection between an alarm viewer process, such as the standard Alarm Viewer, and the AMRP. The classes and their functions are summarized below.
|
|
Class |
Description |
|
CAmvAlarm |
An individual alarm instance |
|
|
CAmvClassFilter |
An Alarm Class (for example, HIGH) |
|
|
CAmvClassFilterList |
The set of classes used to filter alarms for a connection. |
|
|
CAmvConn |
A connection to an AMRP. This is the most important class in the AMV API. An instance of CAmvConn has members which are filter objects and are used to control filtering and sorting alarms through the connection. |
|
|
CAmvResourceFilter |
A Resource |
|
|
CAmvResourceFilterList |
The set of resources used to filter alarms for a connection. |
|
|
CAmvSetupList |
A way to access Alarm Viewer saved setups |
|
|
CAmvStateFilter |
The set of alarm states used to filter alarms for a connection. |
|
|
CAmvStateFilterList |
A way to loop through the state filters currently in use. |
|
|
CAmvTimeFilter |
The time used to filter alarms for a connection. If enabled, only alarms after the specified time are passed. |
Connections between alarm viewers and the alarm manager are encapsulated in the CAmvConn (Alarm Viewer Connection) class. When a CAmvConn object is constructed, you provide a number of callback functions. The constructor starts a new thread to process alarm manager communication. This thread calls your functions to process alarms.
|
|
What Alarm Viewer Management Does. |
