roswrap::console Namespace Reference

Namespaces
	backend
	levels

Classes
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	Formatter
class	LogAppender
struct	LogLocation
	Internal. More...
struct	Token

Typedefs
typedef levels::Level	Level
typedef std::shared_ptr< Token >	TokenPtr
typedef std::vector< TokenPtr >	V_Token

Functions
ROSCONSOLE_DECL void	checkLogLocationEnabled (LogLocation *loc)
	Internal. More...
ROSCONSOLE_DECL void	formatToBuffer (boost::shared_array< char > &buffer, size_t &buffer_size, const char *fmt,...)
ROSCONSOLE_DECL std::string	formatToString (const char *fmt,...)
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. More...
ROSCONSOLE_DECL void	initializeLogLocation (LogLocation *loc, const std::string &name, Level level)
	Internal. More...
ROSCONSOLE_DECL void	notifyLoggerLevelsChanged ()
	Tells the system that a logger's level has changed. More...
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. More...
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. More...
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. More...
ROSCONSOLE_DECL void	shutdown ()
ROSCONSOLE_DECL void	vformatToBuffer (boost::shared_array< char > &buffer, size_t &buffer_size, const char *fmt, va_list args)

Variables
ROSCONSOLE_DECL Formatter	g_formatter
	Only exported because the implementation need it. Do not use directly. More...
ROSCONSOLE_DECL std::string	g_last_error_message
	Only exported because the macros need it. Do not use directly. More...
struct ROSCONSOLE_DECL	LogLocation

Typedef Documentation

Level

typedef levels::Level roswrap::console::Level

Definition at line 52 of file console_backend.h.

TokenPtr

typedef std::shared_ptr<Token> roswrap::console::TokenPtr

Definition at line 125 of file console.h.

V_Token

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

Definition at line 126 of file console.h.

Function Documentation

checkLogLocationEnabled()

ROSCONSOLE_DECL void roswrap::console::checkLogLocationEnabled

(

LogLocation *

loc

)

Internal.

formatToBuffer()

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

formatToString()

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

get_loggers()

ROSCONSOLE_DECL bool roswrap::console::get_loggers

(

std::map< std::string, levels::Level > &

loggers

)

initialize()

ROSCONSOLE_DECL void roswrap::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 235 of file rossimu.cpp.

initializeLogLocation()

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

Internal.

notifyLoggerLevelsChanged()

ROSCONSOLE_DECL void roswrap::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.

print() [1/2]

ROSCONSOLE_DECL void roswrap::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

print() [2/2]

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

register_appender()

ROSCONSOLE_DECL void roswrap::console::register_appender

(

LogAppender *

appender

)

registerLogLocation()

ROSCONSOLE_DECL void roswrap::console::registerLogLocation

(

LogLocation *

loc

)

Registers a logging location with the system.

This is used for the case where a logger's verbosity level changes, and we need to reset the enabled status of all the logging statements.

Parameters

loc	The location to add

set_logger_level()

ROSCPP_DECL bool roswrap::console::set_logger_level	(	const std::string &	name,
		levels::Level	level
	)

Definition at line 105 of file rossimu.cpp.

setFixedFilterToken()

ROSCONSOLE_DECL void roswrap::console::setFixedFilterToken	(	const std::string &	key,
		const std::string &	val
	)

setLogLocationLevel()

ROSCONSOLE_DECL void roswrap::console::setLogLocationLevel	(	LogLocation *	loc,
		Level	level
	)

Internal.

shutdown()

ROSCONSOLE_DECL void roswrap::console::shutdown

(

)

Definition at line 269 of file rossimu.cpp.

vformatToBuffer()

ROSCONSOLE_DECL void roswrap::console::vformatToBuffer	(	boost::shared_array< char > &	buffer,
		size_t &	buffer_size,
		const char *	fmt,
		va_list	args
	)

Variable Documentation

g_formatter

ROSCONSOLE_DECL Formatter roswrap::console::g_formatter

Only exported because the implementation need it. Do not use directly.

g_last_error_message

ROSCONSOLE_DECL std::string roswrap::console::g_last_error_message

Only exported because the macros need it. Do not use directly.

Only exported because the TopicManager need it. Do not use directly.

LogLocation

struct ROSCONSOLE_DECL roswrap::console::LogLocation

Definition at line 164 of file console.h.