Developer Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Tracing.hh
1 /*===========================================================================*\
2  * *
3  * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39  * *
40 \*===========================================================================*/
41 
42 /*===========================================================================*\
43  * *
44  * $Revision$ *
45  * $Author$ *
46  * $Date$ *
47  * *
48 \*===========================================================================*/
49 
50 
51 
52 
53 //=============================================================================
54 //
55 // CLASS Tracing
56 //
57 //=============================================================================
58 
59 
60 #ifndef ACG_TRACING_HH
61 #define ACG_TRACING_HH
62 
63 
64 //== INCLUDES =================================================================
65 
66 #include "StopWatch.hh"
67 #include <iostream>
68 #include <string>
69 #include "../Config/ACGDefines.hh"
70 
71 
72 //== NAMESPACES ===============================================================
73 
74 namespace ACG {
75 
76 
77 //== HELPER MACROS ============================================================
78 
79 
80 #define ACG_TRACE(_text) ACG::Tracing acg_tracer__(_text)
81 #define ACG_TRACE_CMD(_text, _cmd) { ACG_TRACE(_text); cmd; }
82 
83 #define ACG_TIMED_TRACE(_text) ACG::TimedTracing acg_tracer__(_text)
84 #define ACG_TIMED_TRACE_CMD(_text, _cmd) { ACG_TIMED_TRACE(_text); _cmd; }
85 
86 #define ACG_TRACE_PROGRESS acg_tracer__.progress()
87 
88 
89 //== CLASS DEFINITION =========================================================
90 
91 
125 class ACGDLLEXPORT Tracing
126 {
127 public:
128 
130  Tracing(const std::string& _text,
131  std::ostream& _os = std::cerr)
132  : os_(_os)
133  { os_ << _text << " " << std::flush; }
134 
135 
137  ~Tracing() { os_ << "finished.\n" << std::flush; }
138 
139 
142  void progress() {
143  os_ << progress_[((++idx_)&=0x3)] << "\b" << std::flush;
144  }
145 
146 
147 protected:
148 
149  std::ostream& os_;
150  static char progress_[4];
151  static unsigned char idx_;
152 };
153 
154 
155 //== CLASS DEFINITION =========================================================
156 
157 
158 
188 class ACGDLLEXPORT TimedTracing : public Tracing
189 {
190 public:
191 
193  TimedTracing( const std::string& _text,
194  std::ostream& _os = std::cerr )
195  : Tracing(_text, _os)
196  { timer_.start(); }
197 
198 
201  {
202  os_ << timer_.stop()*0.001 << " secs, ";
203  }
204 
205 private:
206 
207  StopWatch timer_;
208 };
209 
210 
211 
212 //=============================================================================
213 } // namespace ACG
214 //=============================================================================
215 #endif // ACG_TRACING_HH defined
216 //=============================================================================
217 
Namespace providing different geometric functions concerning angles.
Definition: DBSCANT.cc:51
void progress()
Definition: Tracing.hh:142
~TimedTracing()
destructor
Definition: Tracing.hh:200
~Tracing()
Destructor.
Definition: Tracing.hh:137
TimedTracing(const std::string &_text, std::ostream &_os=std::cerr)
default constructor
Definition: Tracing.hh:193
Tracing(const std::string &_text, std::ostream &_os=std::cerr)
Constructor.
Definition: Tracing.hh:130