Helper class to manage warnings that are to be issued when a value enters a predefined range, but repeated only when that value leaves a (wider) "proximity" range and then re-enters the (narrower) "inner" range. More...
#include <YQPkgDiskUsageList.h>
Public Member Functions | |
| YQPkgWarningRangeNotifier () | |
| Constructor. | |
| void | enterRange () |
| Notification that the inner range is entered. More... | |
| void | enterProximity () |
| Notification that the proximity range is entered, i.e. More... | |
| void | warningPostedNotify () |
| Notification that a warning has been posted. | |
| bool | inRange () const |
| Check if the value is in range, i.e. More... | |
| bool | needWarning () const |
| Check if a warning should be posted, i.e. More... | |
| bool | leavingProximity () const |
| Check if the value is leaving the proximity range. | |
| void | clear () |
| Clear the current values, i.e. More... | |
| void | clearHistory () |
| Clear everything, including all history values such as if a warning has been posted. | |
Protected Attributes | |
| bool | _inRange |
| bool | _isClose |
| bool | _hasBeenClose |
| bool | _warningPosted |
Detailed Description
Helper class to manage warnings that are to be issued when a value enters a predefined range, but repeated only when that value leaves a (wider) "proximity" range and then re-enters the (narrower) "inner" range.
Example: Disk space usage:
70% 75% 80% [proximity range start] 85% 90% [inner range start] 95% 100%
A warning is to be posted when there is only 90% disk space left. After the warning is displayed, there shall be no more warning until disk usage decreases below 80% (the proximity range) and then later increases again to 90%.
The net effect of all that is to avoid posting the warning over and over again while the value changes back and forth around the boundary of the ( inner ) warning range.
Definition at line 77 of file YQPkgDiskUsageList.h.
Member Function Documentation
◆ clear()
| void YQPkgWarningRangeNotifier::clear | ( | ) |
Clear the current values, i.e.
prepare for a new round of checks
Definition at line 373 of file YQPkgDiskUsageList.cc.
◆ enterProximity()
| void YQPkgWarningRangeNotifier::enterProximity | ( | ) |
Notification that the proximity range is entered, i.e.
that the value is getting near the inner range. 'enterRange()' automatically includes this, too.
Definition at line 399 of file YQPkgDiskUsageList.cc.
◆ enterRange()
| void YQPkgWarningRangeNotifier::enterRange | ( | ) |
Notification that the inner range is entered.
The caller has to decide the criteria for that.
Definition at line 391 of file YQPkgDiskUsageList.cc.
◆ inRange()
| bool YQPkgWarningRangeNotifier::inRange | ( | ) | const |
Check if the value is in range, i.e.
if anybody from the outside has called 'enterRange()' since the last call to 'clear()'.
Definition at line 414 of file YQPkgDiskUsageList.cc.
◆ needWarning()
| bool YQPkgWarningRangeNotifier::needWarning | ( | ) | const |
Check if a warning should be posted, i.e.
if the value is currently in range ( see 'inRange() ) and there has been no notification yet that a warning has already been posted.
Definition at line 428 of file YQPkgDiskUsageList.cc.
The documentation for this class was generated from the following files:
- /home/abuild/rpmbuild/BUILD/libyui-qt-pkg-2.47.5/src/YQPkgDiskUsageList.h
- /home/abuild/rpmbuild/BUILD/libyui-qt-pkg-2.47.5/src/YQPkgDiskUsageList.cc
