#include <nodelet.h>

Inheritance diagram for cras::NodeletLogHelper:

Public Types
typedef ::std::function< const ::std::string &()>	GetNameFn
	Type of the function returning the name of the nodelet. More...

Public Types inherited from cras::LogHelper
typedef ::std::shared_ptr< const ::cras::LogHelper >	ConstPtr
	Const pointer to `LogHelper`. More...

typedef ::std::shared_ptr<::cras::LogHelper >	Ptr
	Pointer to `LogHelper`. More...

Public Member Functions
void	initializeLogLocationImpl (::ros::console::LogLocation *loc, const ::std::string &name, ::ros::console::Level level) const override

	NodeletLogHelper (const GetNameFn &getNameFn)

Public Member Functions inherited from cras::RosconsoleLogHelper
void	checkLogLocationEnabled (::ros::console::LogLocation *loc) const override
	Check whether the log location is enabled. More...

void	logString (void logger, ::ros::console::Level level, const ::std::string &str, const char file, uint32_t line, const char *function) const override
	Write the given string to the log. More...

void	setLogLocationLevel (::ros::console::LogLocation *loc, ::ros::console::Level level) const override
	Set level of a log location. This is only called when global logging level changes. More...

Public Member Functions inherited from cras::LogHelper
virtual const void *	getId () const
	Return a unique identifier of this logger. These IDs are used for determining which logger has already logged something. More...

virtual ::ros::Time	getTimeNow () const
	Get current time (used for throttling messages). By default, ROS time is returned, with fallback to wall time if ROS time is not initialized. More...

void	initialize () const
	Initialize the logger. This function does what it needs and then calls `initializeImpl()`. More...

void	initializeLogLocation (::ros::console::LogLocation *loc, const std::string &name, ::ros::console::Level level) const
	Initialize the given log location with proper data for later use. This is the function called from macros. This function checks whether log level is within bounds, corrects it if needed, calls `initializeLogLocaionImpl()`, and, if the passed log level was wrong, logs an additional error (after the log location has been initialized by the impl function). More...

void	log (::ros::console::Level level, ::std::string format,...) const
	Log a message using the given log severity. More...

void	log (::ros::console::Level level, const char *format,...) const
	Log a message using the given log severity. More...

	LogHelper ()

	LogHelper (const LogHelper &)=delete

	LogHelper (LogHelper &&)=delete

LogHelper &	operator= (const LogHelper &)=delete

LogHelper &	operator= (LogHelper &&)=delete

void	print (::ros::console::FilterBase filter, void logger, ::ros::console::Level level, const ::std::string &str, const char file, int line, const char function) const
	Print function used by the macros. It basically just relays its work to `logString()`. More...

void	print (::ros::console::FilterBase filter, void logger, ::ros::console::Level level, const ::std::stringstream &ss, const char file, int line, const char function) const
	Print function used by the macros. It basically just relays its work to `logString()`. More...

void void	print (::ros::console::FilterBase filter, void logger, ::ros::console::Level level, const char file, int line, const char function, ::std::string fmt,...) const
	Print function used by the macros. It basically just relays its work to `logString()`. More...

void	print (::ros::console::FilterBase filter, void logger, ::ros::console::Level level, const char file, int line, const char function, const char *fmt,...) const ROSCONSOLE_PRINTF_ATTRIBUTE(8
	Print function used by the macros. It basically just relays its work to `logString()`. More...

void	print (::ros::console::Level level, const ::std::string &text) const
	Log a message using the given log severity. More...

void	setGlobalLogger () const

virtual	~LogHelper ()=default

Protected Attributes
GetNameFn	getNameFn
	Function returning the name of the nodelet. More...

Additional Inherited Members
Public Attributes inherited from cras::LogHelper
bool	initialized {false}
	Whether `initialize()` has been called at least once. Subclasses are required to handle this invariant. More...

Protected Member Functions inherited from cras::RosconsoleLogHelper
void	initializeImpl () const override
	Initialize the logger. It is not needed to check `initialized` as this function is only called when it was false. More...

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

Protected Member Functions inherited from cras::LogHelper
virtual void	initializeLogLocationImpl (::ros::console::LogLocation *loc, const std::string &name, ::ros::console::Level level) const =0
	Initialize the given log location with proper data for later use. This function is only called if the log location was not already initialized. More...

Detailed Description

Log helper delegating the logging calls to the NODELET_ macros.

Definition at line 24 of file nodelet.h.

Member Typedef Documentation

◆ GetNameFn

typedef ::std::function<const ::std::string&()> cras::NodeletLogHelper::GetNameFn

Type of the function returning the name of the nodelet.

Definition at line 28 of file nodelet.h.

Constructor & Destructor Documentation

◆ NodeletLogHelper()

cras::NodeletLogHelper::NodeletLogHelper ( const GetNameFn & getNameFn )

explicit

Create the log helper reporting as the nodelet of name returned by getNameFn.

Parameters

getNameFn A function returning the name of the nodelet.

Member Function Documentation

◆ initializeLogLocationImpl()

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

override

Member Data Documentation

◆ getNameFn

GetNameFn cras::NodeletLogHelper::getNameFn

protected

Function returning the name of the nodelet.

Definition at line 41 of file nodelet.h.

The documentation for this class was generated from the following file:

nodelet.h

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members