src/ompl/util/Console.h File Reference

#include <string>

Include dependency graph for Console.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	ompl::msg::OutputHandler
	Generic class to handle output from a piece of code. More...
class	ompl::msg::OutputHandlerSTD
	Default implementation of OutputHandler. This sends the information to the console. More...
class	ompl::msg::OutputHandlerFile
	Implementation of OutputHandler that saves messages in a file. More...
Namespaces
namespace	ompl
	Main namespace. Contains everything in this library.
namespace	ompl::msg
	Message namespace. This contains classes needed to output error messages (or logging) from within the library. Message logging can be performed with logging macros.
Defines
#define	logError(fmt,...)   ompl::msg::log(__FILE__, __LINE__, ompl::msg::LOG_ERROR, fmt, ##__VA_ARGS__)
	Log a formatted error string.
#define	logWarn(fmt,...)   ompl::msg::log(__FILE__, __LINE__, ompl::msg::LOG_WARN, fmt, ##__VA_ARGS__)
	Log a formatted warning string.
#define	logInform(fmt,...)   ompl::msg::log(__FILE__, __LINE__, ompl::msg::LOG_INFO, fmt, ##__VA_ARGS__)
	Log a formatted information string.
#define	logDebug(fmt,...)   ompl::msg::log(__FILE__, __LINE__, ompl::msg::LOG_DEBUG, fmt, ##__VA_ARGS__)
	Log a formatted debugging string.
Enumerations
enum	ompl::msg::LogLevel {   LOG_DEBUG = 0, LOG_INFO, LOG_WARN, LOG_ERROR,   LOG_NONE }
	The set of priorities for message logging.
Functions
void	ompl::msg::noOutputHandler (void)
	This function instructs ompl that no messages should be outputted. Equivalent to useOutputHandler(NULL)
void	ompl::msg::restorePreviousOutputHandler (void)
	Restore the output handler that was previously in use (if any)
void	ompl::msg::useOutputHandler (OutputHandler *oh)
	Specify the instance of the OutputHandler to use. By default, this is OutputHandlerSTD.
OutputHandler *	ompl::msg::getOutputHandler (void)
	Get the instance of the OutputHandler currently used. This is NULL in case there is no output handler.
void	ompl::msg::setLogLevel (LogLevel level)
	Set the minimum level of logging data to output. Messages with lower logging levels will not be recorded.
LogLevel	ompl::msg::getLogLevel (void)
	Retrieve the current level of logging data. Messages with lower logging levels will not be recorded.
void	ompl::msg::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. Formats the message string given the arguments and forwards the string to the output handler.

---

Detailed Description

Definition in file Console.h.