1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
|
/* This file is part of the FaCT++ DL reasoner
Copyright (C) 2003-2015 Dmitry Tsarkov and The University of Manchester
Copyright (C) 2015-2016 Dmitry Tsarkov
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef PROGRESSINDICATORINTERFACE_H
#define PROGRESSINDICATORINTERFACE_H
/// interface of the progress indicator
class ProgressIndicatorInterface
{
protected: // members
/// limit of the progress: indicate [0..uLimit]
unsigned long uLimit;
/// current value of an indicator
unsigned long uCurrent;
protected: // methods
/// initial exposure method: can be overriden in derived classes
virtual void initExposure ( void ) {}
/// indicate current value somehow
virtual void expose ( void ) = 0;
/// check whether the limit is reached
bool checkMax ( void )
{
if ( uCurrent > uLimit )
{
uCurrent = uLimit;
return true;
}
else
return false;
}
public: // interface
/// empty c'tor
ProgressIndicatorInterface ( void ) : uLimit (0), uCurrent (0) {}
/// init c'tor
ProgressIndicatorInterface ( unsigned long limit ) : uCurrent (0)
{ setLimit (limit); }
/// empty d'tor
virtual ~ProgressIndicatorInterface ( void ) {}
/// set indicator to a given VALUE
void setIndicator ( unsigned long value )
{
if ( uCurrent != value )
{
uCurrent = value;
checkMax ();
expose ();
}
}
/// increment current value of an indicator to DELTA steps
void incIndicator ( unsigned long delta = 1 ) { setIndicator(uCurrent+delta); }
/// set indicator to 0
void reset ( void ) { setIndicator (0); }
/// set the limit of an indicator to a given VALUE
void setLimit ( unsigned long limit ) { uLimit = limit; reset(); initExposure(); }
}; // ProgressIndicatorInterface
#endif
|