MIRA
LogTimer.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 by
3  * MetraLabs GmbH (MLAB), GERMANY
4  * and
5  * Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
6  * All rights reserved.
7  *
8  * Contact: info@mira-project.org
9  *
10  * Commercial Usage:
11  * Licensees holding valid commercial licenses may use this file in
12  * accordance with the commercial license agreement provided with the
13  * software or, alternatively, in accordance with the terms contained in
14  * a written agreement between you and MLAB or NICR.
15  *
16  * GNU General Public License Usage:
17  * Alternatively, this file may be used under the terms of the GNU
18  * General Public License version 3.0 as published by the Free Software
19  * Foundation and appearing in the file LICENSE.GPL3 included in the
20  * packaging of this file. Please review the following information to
21  * ensure the GNU General Public License version 3.0 requirements will be
22  * met: http://www.gnu.org/copyleft/gpl.html.
23  * Alternatively you may (at your option) use any later version of the GNU
24  * General Public License if such license has been publicly approved by
25  * MLAB and NICR (or its successors, if any).
26  *
27  * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
28  * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
29  * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
30  * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
33  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
34  * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
35  * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
36  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
37  */
38 
47 #ifndef _MIRA_LOGTIMER_H_
48 #define _MIRA_LOGTIMER_H_
49 
50 #include <error/LoggingCore.h>
51 #include <error/LoggingCore.h>
53 
54 namespace mira
55 {
56 
58 
78 {
79 public:
80 
82  LogTimer(SeverityLevel level,
83  const char* name,
84  const Time& time,
85  const char* file, int line,
86  const char* function,
87  ThreadID threadID,
88  const std::string& caption);
89 
91  ~LogTimer();
92 
96  Duration peek() const;
97 
102  void end();
103 
104 private:
105  LogRecord mRecord;
106  std::string mCaption;
107  bool mEnded;
108 };
109 
111 
117 #define MIRA_LOGTIMER(level, name, text) \
118  constexpr auto fileInMIRAPath##name = mira::chopMIRAPath(__FILE__); \
119  LogTimer name(level, #name, Time::now(), \
120  fileInMIRAPath##name, __LINE__, \
121  MIRA_FUNCTION, getCurrentThreadID(), text);
122 
128 #define MIRA_PEEKLOGTIMER(name) name.peek();
129 
135 #define MIRA_ENDLOGTIMER(name) name.end();
136 
138 
139 }
140 
141 #endif
Holds all the information about a log entry.
Definition: LoggingCore.h:107
PropertyHint file(const std::string &filters=std::string(), bool save=false)
Tells the property editor that the path is for a file, and that it should show a "File Open"/"File Sa...
Definition: Path.h:247
specialize cv::DataType for our ImgPixel and inherit from cv::DataType<Vec>
Definition: IOService.h:67
Compile-time path handling.
uint32 ThreadID
Platform independent thread ID.
Definition: ThreadID.h:68
SeverityLevel
Severity levels to graduate between different log outputs.
Definition: LoggingCore.h:72
Wrapper class for boost::posix_time::ptime for adding more functionality to it.
Definition: Time.h:418
Core class of the logging library.
Use this class to represent time durations.
Definition: Time.h:106
Class that can be used as a stop watch to measure execution time of operations.
Definition: LogTimer.h:77
#define MIRA_BASE_EXPORT
This is required because on windows there is a macro defined called ERROR.
Definition: Platform.h:153