All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends
Console.h
Go to the documentation of this file.
1 /*********************************************************************
2 * Software License Agreement (BSD License)
3 *
4 * Copyright (c) 2008, Willow Garage, Inc.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
17 * * Neither the name of the Willow Garage nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 *********************************************************************/
34 
35 /* Author: Ioan Sucan */
36 
37 #ifndef OMPL_UTIL_CONSOLE_
38 #define OMPL_UTIL_CONSOLE_
39 
40 #include <string>
41 
64 #define OMPL_ERROR(fmt, ...) ompl::msg::log(__FILE__, __LINE__, ompl::msg::LOG_ERROR, fmt, ##__VA_ARGS__)
65 
66 #define OMPL_WARN(fmt, ...) ompl::msg::log(__FILE__, __LINE__, ompl::msg::LOG_WARN, fmt, ##__VA_ARGS__)
67 
68 #define OMPL_INFORM(fmt, ...) ompl::msg::log(__FILE__, __LINE__, ompl::msg::LOG_INFO, fmt, ##__VA_ARGS__)
69 
70 #define OMPL_DEBUG(fmt, ...) ompl::msg::log(__FILE__, __LINE__, ompl::msg::LOG_DEBUG, fmt, ##__VA_ARGS__)
71 
72 namespace ompl
73 {
74 
78  namespace msg
79  {
81  enum LogLevel
82  {
83  LOG_DEBUG = 0,
84  LOG_INFO,
85  LOG_WARN,
86  LOG_ERROR,
87  LOG_NONE
88  };
89 
98  {
99  public:
100 
101  OutputHandler(void)
102  {
103  }
104 
105  virtual ~OutputHandler(void)
106  {
107  }
108 
111  virtual void log(const std::string &text, LogLevel level, const char *filename, int line) = 0;
112  };
113 
117  {
118  public:
119 
121  {
122  }
123 
124  virtual void log(const std::string &text, LogLevel level, const char *filename, int line);
125 
126  };
127 
130  {
131  public:
132 
134  OutputHandlerFile(const char *filename);
135 
136  virtual ~OutputHandlerFile(void);
137 
138  virtual void log(const std::string &text, LogLevel level, const char *filename, int line);
139 
140  private:
141 
143  FILE *file_;
144 
145  };
146 
148  void noOutputHandler(void);
149 
151  void restorePreviousOutputHandler(void);
152 
155 
158 
161  void setLogLevel(LogLevel level);
162 
165  LogLevel getLogLevel(void);
166 
170  void log(const char *file, int line, LogLevel level, const char* m, ...);
171  }
172 
173 }
174 
175 #endif
void log(const char *file, int line, LogLevel level, const char *m,...)
Root level logging function. This should not be invoked directly, but rather used via a logging macro...
Definition: Console.cpp:104
virtual void log(const std::string &text, LogLevel level, const char *filename, int line)
log a message to the output handler with the given text and logging level from a specific file and li...
Definition: Console.cpp:134
virtual void log(const std::string &text, LogLevel level, const char *filename, int line)
log a message to the output handler with the given text and logging level from a specific file and li...
Definition: Console.cpp:163
LogLevel getLogLevel(void)
Retrieve the current level of logging data. Messages with lower logging levels will not be recorded...
Definition: Console.cpp:126
void setLogLevel(LogLevel level)
Set the minimum level of logging data to output. Messages with lower logging levels will not be recor...
Definition: Console.cpp:120
Generic class to handle output from a piece of code.
Definition: Console.h:97
virtual void log(const std::string &text, LogLevel level, const char *filename, int line)=0
log a message to the output handler with the given text and logging level from a specific file and li...
Implementation of OutputHandler that saves messages in a file.
Definition: Console.h:129
Default implementation of OutputHandler. This sends the information to the console.
Definition: Console.h:116
void useOutputHandler(OutputHandler *oh)
Specify the instance of the OutputHandler to use. By default, this is OutputHandlerSTD.
Definition: Console.cpp:92
OutputHandlerFile(const char *filename)
The name of the file in which to save the message data.
Definition: Console.cpp:149
OutputHandler * getOutputHandler(void)
Get the instance of the OutputHandler currently used. This is NULL in case there is no output handler...
Definition: Console.cpp:99
void noOutputHandler(void)
This function instructs ompl that no messages should be outputted. Equivalent to useOutputHandler(NUL...
Definition: Console.cpp:79
void restorePreviousOutputHandler(void)
Restore the output handler that was previously in use (if any)
Definition: Console.cpp:86
LogLevel
The set of priorities for message logging.
Definition: Console.h:81