console_bridge_dev  master
It is a ROS-independent, pure CMake (i.e. non-catkin and non-rosbuild package) that provides logging calls that mirror those found in rosconsole, but for applications that are not necessarily using ROS.
Classes | Namespaces | Macros | Functions | Variables
console.h File Reference
#include <string>
#include "./console_bridge_export.h"
Include dependency graph for console.h:

Go to the source code of this file.

Classes

class  console_bridge::OutputHandler
 Generic class to handle output from a piece of code. More...
 
class  console_bridge::OutputHandlerSTD
 Default implementation of OutputHandler. This sends the information to the console. More...
 
class  console_bridge::OutputHandlerFile
 Implementation of OutputHandler that saves messages in a file. More...
 

Namespaces

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

Macros

#define CONSOLE_BRIDGE_logError(...)   console_bridge::log(__FILE__, __LINE__, console_bridge::CONSOLE_BRIDGE_LOG_ERROR, __VA_ARGS__)
 Log a formatted error string. More...
 
#define CONSOLE_BRIDGE_logWarn(...)   console_bridge::log(__FILE__, __LINE__, console_bridge::CONSOLE_BRIDGE_LOG_WARN, __VA_ARGS__)
 Log a formatted warning string. More...
 
#define CONSOLE_BRIDGE_logInform(...)   console_bridge::log(__FILE__, __LINE__, console_bridge::CONSOLE_BRIDGE_LOG_INFO, __VA_ARGS__)
 Log a formatted information string. More...
 
#define CONSOLE_BRIDGE_logDebug(...)   console_bridge::log(__FILE__, __LINE__, console_bridge::CONSOLE_BRIDGE_LOG_DEBUG, __VA_ARGS__)
 Log a formatted debugging string. More...
 

Functions

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

Variables

 CONSOLE_BRIDGE_LOG_DEBUG = 0
 
 CONSOLE_BRIDGE_LOG_INFO
 
 CONSOLE_BRIDGE_LOG_WARN
 
 CONSOLE_BRIDGE_LOG_ERROR
 

Variable Documentation

◆ CONSOLE_BRIDGE_LOG_DEBUG

CONSOLE_BRIDGE_LOG_DEBUG = 0

◆ CONSOLE_BRIDGE_LOG_INFO

CONSOLE_BRIDGE_LOG_INFO

◆ CONSOLE_BRIDGE_LOG_WARN

CONSOLE_BRIDGE_LOG_WARN

◆ CONSOLE_BRIDGE_LOG_ERROR

CONSOLE_BRIDGE_LOG_ERROR