progress_bar.h
Go to the documentation of this file.
1 // *****************************************************************************
2 //
3 // Copyright (c) 2014, Southwest Research Institute® (SwRI®)
4 // All rights reserved.
5 //
6 // Redistribution and use in source and binary forms, with or without
7 // modification, are permitted provided that the following conditions are met:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of Southwest Research Institute® (SwRI®) nor the
14 // names of its contributors may be used to endorse or promote products
15 // derived from this software without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 // ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
21 // DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 // ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 //
28 // *****************************************************************************
29 
30 #ifndef CONSOLE_UTIL_PROGRESS_BAR_H_
31 #define CONSOLE_UTIL_PROGRESS_BAR_H_
32 
33 #include <termios.h>
34 #include <string>
35 
36 #include <ros/ros.h>
37 
39 {
41  {
42  public:
43  ProgressBar();
44  ~ProgressBar();
45 
46  void SetStartTime(const ros::WallTime& start_time);
47  void SetProgress(double percent_complete);
48  void PrintTime();
49  void CheckForPause();
50  signed char ReadCharFromStdin();
51 
52  static std::string GetTimeString(double seconds);
53  static std::string IntToString(int64_t i, int width = 0);
54 
55  private:
56  void SetupTerminal();
57  void RestoreTerminal();
58 
59  bool paused_;
60 
62 
65 
66  termios orig_flags_;
67  fd_set stdin_fdset_;
68  int maxfd_;
69  };
70 }
71 
72 #endif // CONSOLE_UTIL_PROGRESS_BAR_H_
swri_console_util::ProgressBar::orig_flags_
termios orig_flags_
Definition: progress_bar.h:66
swri_console_util::ProgressBar::paused_
bool paused_
Definition: progress_bar.h:59
swri_console_util::ProgressBar::paused_time_
ros::WallDuration paused_time_
Definition: progress_bar.h:64
swri_console_util::ProgressBar::SetProgress
void SetProgress(double percent_complete)
Definition: progress_bar.cpp:56
ros.h
swri_console_util::ProgressBar::stdin_fdset_
fd_set stdin_fdset_
Definition: progress_bar.h:67
swri_console_util::ProgressBar::ReadCharFromStdin
signed char ReadCharFromStdin()
Definition: progress_bar.cpp:134
swri_console_util::ProgressBar::maxfd_
int maxfd_
Definition: progress_bar.h:68
swri_console_util::ProgressBar::GetTimeString
static std::string GetTimeString(double seconds)
Definition: progress_bar.cpp:173
swri_console_util::ProgressBar::IntToString
static std::string IntToString(int64_t i, int width=0)
Definition: progress_bar.cpp:222
swri_console_util::ProgressBar::start_time_
ros::WallTime start_time_
Definition: progress_bar.h:63
swri_console_util::ProgressBar::~ProgressBar
~ProgressBar()
Definition: progress_bar.cpp:46
swri_console_util
Definition: progress_bar.h:38
swri_console_util::ProgressBar
Definition: progress_bar.h:40
swri_console_util::ProgressBar::SetupTerminal
void SetupTerminal()
Definition: progress_bar.cpp:150
swri_console_util::ProgressBar::SetStartTime
void SetStartTime(const ros::WallTime &start_time)
Definition: progress_bar.cpp:51
swri_console_util::ProgressBar::RestoreTerminal
void RestoreTerminal()
Definition: progress_bar.cpp:167
ros::WallTime
swri_console_util::ProgressBar::PrintTime
void PrintTime()
Definition: progress_bar.cpp:61
swri_console_util::ProgressBar::percent_complete_
double percent_complete_
Definition: progress_bar.h:61
swri_console_util::ProgressBar::CheckForPause
void CheckForPause()
Definition: progress_bar.cpp:105
ros::WallDuration
swri_console_util::ProgressBar::ProgressBar
ProgressBar()
Definition: progress_bar.cpp:37


swri_console_util
Author(s): Marc Alban
autogenerated on Fri Aug 2 2024 08:39:10