libyui-ncurses-pkg  2.46.1
 All Classes Functions
NCPkgWarningRangeNotifier Class Reference

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 <NCPkgPopupDiskspace.h>

Public Member Functions

 NCPkgWarningRangeNotifier ()
 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 logSettings () const
 
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 92 of file NCPkgPopupDiskspace.h.

Member Function Documentation

void NCPkgWarningRangeNotifier::clear ( )

Clear the current values, i.e.

prepare for a new round of checks

Definition at line 578 of file NCPkgPopupDiskspace.cc.

void NCPkgWarningRangeNotifier::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 604 of file NCPkgPopupDiskspace.cc.

void NCPkgWarningRangeNotifier::enterRange ( )

Notification that the inner range is entered.

The caller has to decide the criteria for that.

Definition at line 596 of file NCPkgPopupDiskspace.cc.

Here is the call graph for this function:

bool NCPkgWarningRangeNotifier::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 619 of file NCPkgPopupDiskspace.cc.

bool NCPkgWarningRangeNotifier::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 633 of file NCPkgPopupDiskspace.cc.


The documentation for this class was generated from the following files: