/usr/include/mia-2.4/mia/core/callback.hh is in libmia-2.4-dev 2.4.3-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 | /* -*- mia-c++ -*-
*
* This file is part of MIA - a toolbox for medical image analysis
* Copyright (c) Leipzig, Madrid 1999-2016 Gert Wollny
*
* MIA is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with MIA; if not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef mia_callback_hh
#define mia_callback_hh
#include <string>
#include <mia/core/defines.hh>
NS_MIA_BEGIN
/**
\ingroup misc
\brief a class to provide a feedback mechanism to show progress
This class is used as a base class in order to show feedback about the
progress of certain operations that may take a long time.
The indicator supports two modes of operation: If the number if steps
is known beforehand, the indicator will act like a classical progress bar, and
If the number of stels is unknown, some kind of change indicator is applied
to show that "something happens".
*/
class EXPORT_CORE CProgressCallback {
public:
virtual ~CProgressCallback();
/**
Set the maximum number of the possible steps some operatoion may take
\param range
*/
void set_range(int range);
/**
Update the progress indicator by using the given value - it should be
less or equal to the value given in set_range().
\param step
*/
void update(int step);
/**
Update the progress indicator in some way to show that something is happening
but without giving real target informations.
*/
void pulse();
private:
virtual void do_update(int step) = 0;
virtual void do_set_range(int range) = 0;
virtual void do_pulse() = 0;
};
/**
\ingroup helpers
\brief a class to provide a feedback mechanism to show progress based on textual output
This class provides progress feedback on textual outputs. The range based output
shows progress in percent, and the pluse output prints a '.' whenever it is called.
*/
class EXPORT_CORE CMsgStreamPrintCallback: public CProgressCallback {
public:
/**
Constructor for the text based callback that uses msgstream for output.
\param format the output format. It should contain the format descriptors
%1% for the current progress and %2% for the progress range.
*/
CMsgStreamPrintCallback(const std::string& format);
virtual ~CMsgStreamPrintCallback();
private:
virtual void do_update(int step);
virtual void do_set_range(int range);
virtual void do_pulse();
struct CMsgStreamPrintCallbackImpl *impl;
};
NS_MIA_END
#endif
|