Message namespace. This contains classes needed to output error messages (or logging) from within the library. Message logging can be performed with logging macros. More...
Classes | |
class | OutputHandler |
Generic class to handle output from a piece of code. More... | |
class | OutputHandlerFile |
Implementation of OutputHandler that saves messages in a file. More... | |
class | OutputHandlerSTD |
Default implementation of OutputHandler. This sends the information to the console. More... | |
Enumerations | |
enum | LogLevel { CONSOLE_BRIDGE_LOG_DEBUG = 0, CONSOLE_BRIDGE_LOG_INFO, CONSOLE_BRIDGE_LOG_WARN, CONSOLE_BRIDGE_LOG_ERROR, CONSOLE_BRIDGE_LOG_NONE } |
The set of priorities for message logging. More... | |
Functions | |
LogLevel | getLogLevel (void) |
Retrieve the current level of logging data. Messages with lower logging levels will not be recorded. More... | |
OutputHandler * | getOutputHandler (void) |
Get the instance of the OutputHandler currently used. This is NULL in case there is no output handler. More... | |
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. Formats the message string given the arguments and forwards the string to the output handler. More... | |
CONSOLE_BRIDGE_DEPRECATED void | log_deprecated (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. More... | |
void | noOutputHandler (void) |
This function instructs ompl that no messages should be outputted. Equivalent to useOutputHandler(NULL) More... | |
void | restorePreviousOutputHandler (void) |
Restore the output handler that was previously in use (if any) More... | |
void | setLogLevel (LogLevel level) |
Set the minimum level of logging data to output. Messages with lower logging levels will not be recorded. More... | |
void | useOutputHandler (OutputHandler *oh) |
Specify the instance of the OutputHandler to use. By default, this is OutputHandlerSTD. More... | |
Message namespace. This contains classes needed to output error messages (or logging) from within the library. Message logging can be performed with logging macros.
console_bridge::LogLevel console_bridge::getLogLevel | ( | void | ) |
Retrieve the current level of logging data. Messages with lower logging levels will not be recorded.
Definition at line 158 of file console.cpp.
console_bridge::OutputHandler * console_bridge::getOutputHandler | ( | void | ) |
Get the instance of the OutputHandler currently used. This is NULL in case there is no output handler.
Definition at line 101 of file console.cpp.
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.
Definition at line 132 of file console.cpp.
void console_bridge::log_deprecated | ( | 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.
Definition at line 106 of file console.cpp.
This function instructs ompl that no messages should be outputted. Equivalent to useOutputHandler(NULL)
Definition at line 81 of file console.cpp.
Restore the output handler that was previously in use (if any)
Definition at line 88 of file console.cpp.
Set the minimum level of logging data to output. Messages with lower logging levels will not be recorded.
Definition at line 152 of file console.cpp.
void console_bridge::useOutputHandler | ( | OutputHandler * | oh | ) |
Specify the instance of the OutputHandler to use. By default, this is OutputHandlerSTD.
Definition at line 94 of file console.cpp.