Namespaces
namespace	backend
namespace	impl
namespace	levels
Classes
struct	FileToken
class	FilterBase
	Base-class for filters. Filters allow full user-defined control over whether or not a message should print. The ROS_X_FILTER... macros provide the filtering functionality. More...
struct	FilterParams
	Parameter structure passed to FilterBase::isEnabled(...);. Includes both input and output parameters. More...
struct	FixedMapToken
struct	FixedToken
struct	Formatter
struct	FunctionToken
struct	LineToken
class	LogAppender
struct	LoggerToken
struct	LogLocation
	Internal. More...
struct	MessageToken
struct	PlaceHolderToken
struct	SeverityToken
class	StaticInit
struct	ThreadToken
struct	TimeToken
struct	Token
Typedefs
typedef levels::Level	Level
typedef std::map< std::string, std::string >	M_string
typedef boost::shared_ptr< Token >	TokenPtr
typedef std::vector < LogLocation * >	V_LogLocation
typedef std::vector< TokenPtr >	V_Token
Functions
void	_print (void logger_handle,::ros::console::Level level, const char str, const char file, const char function, int line)
ROSCONSOLE_DECL void	checkLogLocationEnabled (LogLocation *loc)
	Internal.
void	checkLogLocationEnabledNoLock (LogLocation *loc)
TokenPtr	createTokenFromType (const std::string &type)
ROSCONSOLE_DECL void	formatToBuffer (boost::shared_array< char > &buffer, size_t &buffer_size, const char *fmt,...)
ROSCONSOLE_DECL std::string	formatToString (const char *fmt,...)
static boost::shared_array< char >	g_print_buffer (new char[INITIAL_BUFFER_SIZE])
ROSCONSOLE_DECL bool	get_loggers (std::map< std::string, levels::Level > &loggers)
ROSCONSOLE_DECL void	initialize ()
	Don't call this directly. Performs any required initialization/configuration. Happens automatically when using the macro API.
ROSCONSOLE_DECL void	initializeLogLocation (LogLocation *loc, const std::string &name, Level level)
	Internal.
ROSCONSOLE_DECL void	notifyLoggerLevelsChanged ()
	Tells the system that a logger's level has changed.
ROSCONSOLE_DECL void	print (FilterBase filter, void logger, Level level, const char file, int line, const char function, const char *fmt,...) ROSCONSOLE_PRINTF_ATTRIBUTE(7
	Don't call this directly. Use the ROS_LOG() macro instead.
ROSCONSOLE_DECL void ROSCONSOLE_DECL void	print (FilterBase filter, void logger, Level level, const std::stringstream &str, const char file, int line, const char function)
ROSCONSOLE_DECL void	register_appender (LogAppender *appender)
ROSCONSOLE_DECL void	registerLogLocation (LogLocation *loc)
	Registers a logging location with the system.
ROSCONSOLE_DECL bool	set_logger_level (const std::string &name, levels::Level level)
ROSCONSOLE_DECL void	setFixedFilterToken (const std::string &key, const std::string &val)
ROSCONSOLE_DECL void	setLogLocationLevel (LogLocation *loc, Level level)
	Internal.
ROSCONSOLE_DECL void	shutdown ()
ROSCONSOLE_DECL void	vformatToBuffer (boost::shared_array< char > &buffer, size_t &buffer_size, const char *fmt, va_list args)
Variables
M_string	g_extra_fixed_tokens
const char *	g_format_string = "[${severity}] [${time}]: ${message}"
ROSCONSOLE_DECL Formatter	g_formatter
	Only exported because the implementation need it. Do not use directly.
boost::mutex	g_init_mutex
ROSCONSOLE_DECL bool	g_initialized = false
	Only exported because the macros need it. Do not use directly.
ROSCONSOLE_DECL std::string	g_last_error_message = "Unknown Error"
	Only exported because the TopicManager need it. Do not use directly.
boost::mutex	g_locations_mutex
V_LogLocation	g_log_locations
static size_t	g_print_buffer_size = INITIAL_BUFFER_SIZE
static boost::mutex	g_print_mutex
static boost::thread::id	g_printing_thread_id
bool	g_shutting_down = false
StaticInit	g_static_init
struct ROSCONSOLE_DECL	LogLocation

Typedef Documentation

typedef levels::Level ros::console::Level

Definition at line 51 of file console_backend.h.

typedef std::map<std::string, std::string> ros::console::M_string

Definition at line 109 of file rosconsole.cpp.

typedef boost::shared_ptr<Token> ros::console::TokenPtr

Definition at line 120 of file console.h.

typedef std::vector<LogLocation*> ros::console::V_LogLocation

Definition at line 594 of file rosconsole.cpp.

typedef std::vector<TokenPtr> ros::console::V_Token

Definition at line 121 of file console.h.

Function Documentation

void ros::console::_print	(	void *	logger_handle,
		::ros::console::Level	level,
		const char *	str,
		const char *	file,
		const char *	function,
		int	line
	)

Definition at line 380 of file rosconsole.cpp.

void ros::console::checkLogLocationEnabled ( LogLocation * loc )

Internal.

Definition at line 634 of file rosconsole.cpp.

void ros::console::checkLogLocationEnabledNoLock ( LogLocation * loc )

Definition at line 604 of file rosconsole.cpp.

TokenPtr ros::console::createTokenFromType ( const std::string & type )

Definition at line 257 of file rosconsole.cpp.

void ros::console::formatToBuffer	(	boost::shared_array< char > &	buffer,
		size_t &	buffer_size,
		const char *	fmt,
			...
	)

Definition at line 439 of file rosconsole.cpp.

std::string ros::console::formatToString	(	const char *	fmt,
			...
	)

Definition at line 449 of file rosconsole.cpp.

static boost::shared_array<char> ros::console::g_print_buffer ( new char[INITIAL_BUFFER_SIZE] ) [static]

bool ros::console::get_loggers ( std::map< std::string, levels::Level > & loggers )

Definition at line 675 of file rosconsole.cpp.

void ros::console::initialize ( )

Don't call this directly. Performs any required initialization/configuration. Happens automatically when using the macro API.

If you're going to be using log4cxx or any of the ros::console functions, and need the system to be initialized, use the ROSCONSOLE_AUTOINIT macro.

Definition at line 385 of file rosconsole.cpp.

void ros::console::initializeLogLocation	(	LogLocation *	loc,
		const std::string &	name,
		Level	level
	)

Internal.

Definition at line 609 of file rosconsole.cpp.

void ros::console::notifyLoggerLevelsChanged ( )

Tells the system that a logger's level has changed.

This must be called if a log4cxx::Logger's level has been changed in the middle of an application run. Because of the way the static guard for enablement works, if a logger's level is changed and this function is not called, only logging statements which are first hit *after* the change will be correct wrt that logger.

Definition at line 640 of file rosconsole.cpp.

void ros::console::print	(	FilterBase *	filter,
		void *	logger,
		Level	level,
		const char *	file,
		int	line,
		const char *	function,
		const char *	fmt,
			...
	)

Don't call this directly. Use the ROS_LOG() macro instead.

Parameters:

level	Logging level
file	File this logging statement is from (usually generated with __FILE__)
line	Line of code this logging statement is from (usually generated with __LINE__)
fmt	Format string

Definition at line 469 of file rosconsole.cpp.

void ros::console::print	(	FilterBase *	filter,
		void *	logger,
		Level	level,
		const std::stringstream &	str,
		const char *	file,
		int	line,
		const char *	function
	)