ompl::msg Namespace Reference

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  OutputHandlerSTD
 Default implementation of OutputHandler. This sends the information to the console. More...
 
class  OutputHandlerFile
 Implementation of OutputHandler that saves messages in a file. More...
 

Enumerations

enum  LogLevel {
  LOG_DEV2 = -2 , LOG_DEV1 = -1 , LOG_DEBUG = 0 , LOG_INFO ,
  LOG_WARN , LOG_ERROR , LOG_NONE
}
 The set of priorities for message logging.
 

Functions

void noOutputHandler ()
 This function instructs ompl that no messages should be outputted. Equivalent to useOutputHandler(nullptr)
 
void restorePreviousOutputHandler ()
 Restore the output handler that was previously in use (if any)
 
void useOutputHandler (OutputHandler *oh)
 Specify the instance of the OutputHandler to use. By default, this is OutputHandlerSTD.
 
OutputHandlergetOutputHandler ()
 Get the instance of the OutputHandler currently used. This is nullptr in case there is no output handler.
 
void setLogLevel (LogLevel level)
 Set the minimum level of logging data to output. Messages with lower logging levels will not be recorded.
 
LogLevel getLogLevel ()
 Retrieve the current level of logging data. Messages with lower logging levels will not be recorded.
 
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.
 

Detailed Description

Message namespace. This contains classes needed to output error messages (or logging) from within the library. Message logging can be performed with logging macros.