Miind
ProgressBar.hpp
Go to the documentation of this file.
1 // Copyright (c) 2005 - 2012 Marc de Kamps
2 // 2012 David-Matthias Sichau
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
6 //
7 // * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation
9 // and/or other materials provided with the distribution.
10 // * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software
11 // without specific prior written permission.
12 //
13 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
14 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
15 // DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
16 // USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
17 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
18 //
19 
20 #ifndef MPILIB_UTILITIES_PROGRESSBAR_HPP_
21 #define MPILIB_UTILITIES_PROGRESSBAR_HPP_
22 
23 #include <iostream>
24 
25 
26 namespace MPILib {
27 namespace utilities {
28 
29 class ProgressBar {
30 public:
37  explicit ProgressBar(unsigned long expected_count,
38  const std::string & description = "", std::ostream& os = std::cout);
39 
46  void restart(unsigned long expected_count);
47 
53  unsigned long operator+=(unsigned long increment);
54 
58  unsigned long operator++();
59 
63  unsigned long operator++(int);
64 
65 private:
67  unsigned int _tic;
68 
72  const std::string _description;
76  std::ostream& _outputStream;
77 
83  void display_tic();
84 };
85 
86 } /* namespace utilities */
87 } /* namespace MPILib */
88 #endif /* MPILIB_UTILITIES_PROGRESSBAR_HPP_ */
const std::string _description
Definition: ProgressBar.hpp:72
ProgressBar(unsigned long expected_count, const std::string &description="", std::ostream &os=std::cout)
Definition: ProgressBar.cpp:27
unsigned long operator+=(unsigned long increment)
Definition: ProgressBar.cpp:46
void restart(unsigned long expected_count)
Definition: ProgressBar.cpp:36