A prepared form for displaying alarms of drag-and-dropped control end points More...
Classes | |
| class | AlarmsAddressEditor |
| class | AlarmsListEditorConverter |
| class | AlarmsListEditorValue |
| class | AlarmsProperties |
Public Member Functions | |
| void | ClearRange () |
| Clears the currently assigned range for the displayed alarms. More... | |
| void | Display () |
| Displays the associated alarms viewer form More... | |
| String [] | GetAlarmMessages () |
| Returns a list of alarm messages for the server addresses being monitored. More... | |
| String [] | GetAlarmMessages (Boolean activeOnly, int severity) |
| Returns a list of alarm messages for the server addresses being monitored. More... | |
| int | GetNumberOfActiveAlarms () |
| Returns the number of active alarm messages over the time range More... | |
| int | GetNumberOfAlarms () |
| Returns the total number of alarm messages over the time range More... | |
| void | SetRange (double StartTime, double StopTime) |
| Sets the time range for the displayed alarms (based on alarm time) More... | |
Protected Member Functions | |
| override void | Dispose (bool disposing) |
| Clean up any resources being used. More... | |
Properties | |
| Boolean | AcquireAnyDevice [get, set] |
| If 'true' then the alarm acquisition should be for any device More... | |
| BlinkMode | BlinkOnAlarms [get, set] |
| Set/Get the alarm icon blink mode More... | |
| Int32 | DepthInHours [get, set] |
| Alarm acquisition depth in hours (minimum 1) More... | |
| String | Protocol [get, set] |
| The default link control system protocol in the address editor More... | |
| AcopAlarmsViewer.AlarmsListEditorValue | StartupAlarmsList [get, set] |
| Gets/Sets the alarms viewer startup list More... | |
Detailed Description
A prepared form for displaying alarms of drag-and-dropped control end points
Member Function Documentation
◆ ClearRange()
|
inline |
Clears the currently assigned range for the displayed alarms.
◆ Display()
|
inline |
Displays the associated alarms viewer form
◆ Dispose()
|
inlineprotected |
Clean up any resources being used.
- Parameters
-
disposing true if managed resources should be disposed; otherwise, false.
◆ GetAlarmMessages() [1/2]
|
inline |
Returns a list of alarm messages for the server addresses being monitored.
- Returns
- a list of alarm messages for the server addresses being monitored.
Referenced by AcopStatusBar.GetAlarmMessages().
◆ GetAlarmMessages() [2/2]
|
inline |
Returns a list of alarm messages for the server addresses being monitored.
- Parameters
-
activeOnly if 'true' only return active alarms severity desired minimum severty
- Returns
- a list of alarm messages for the server addresses being monitored.
References AcopUtils.GetUtcNow().
◆ GetNumberOfActiveAlarms()
|
inline |
Returns the number of active alarm messages over the time range
- Returns
- Returns the number of active alarm messages over the time range
Referenced by AcopStatusBar.GetNumberOfActiveAlarms().
◆ GetNumberOfAlarms()
|
inline |
Returns the total number of alarm messages over the time range
- Returns
- the total number of alarm messages over the time range
Referenced by AcopStatusBar.GetNumberOfAlarms().
◆ SetRange()
|
inline |
Sets the time range for the displayed alarms (based on alarm time)
- Parameters
-
StartTime the start time (UTC seconds); 0 => use default (24 hours ago) StopTime the stop time (UTC seconds); 0 => use default (Now)
Property Documentation
◆ AcquireAnyDevice
|
getset |
If 'true' then the alarm acquisition should be for any device
◆ BlinkOnAlarms
|
getset |
Set/Get the alarm icon blink mode
◆ DepthInHours
|
getset |
Alarm acquisition depth in hours (minimum 1)
◆ Protocol
|
getset |
The default link control system protocol in the address editor
◆ StartupAlarmsList
|
getset |
Gets/Sets the alarms viewer startup list
The documentation for this class was generated from the following files:
- AcopAlarmsViewer.cs
- AcopAlarmsViewer.Designer.cs
