Public Types
enum class	Level { Unset = RCUTILS_LOG_SEVERITY_UNSET , Debug = RCUTILS_LOG_SEVERITY_DEBUG , Info = RCUTILS_LOG_SEVERITY_INFO , Warn = RCUTILS_LOG_SEVERITY_WARN , Error = RCUTILS_LOG_SEVERITY_ERROR , Fatal = RCUTILS_LOG_SEVERITY_FATAL }
	An enum for the type of logger level. More...

Public Member Functions
RCLCPP_PUBLIC	Logger (const Logger &)=default

RCLCPP_PUBLIC const char *	get_name () const
	Get the name of this logger. More...

RCLCPP_PUBLIC Logger	get_child (const std::string &suffix)
	Return a logger that is a descendant of this logger. More...

RCLCPP_PUBLIC void	set_level (Level level)
	Set level for current logger. More...

Friends
Logger	rclcpp::get_logger (const std::string &name)

Detailed Description

Definition at line 91 of file logger.hpp.

Member Enumeration Documentation

◆ Level

enum rclcpp::Logger::Level

strong

An enum for the type of logger level.

Enumerator
Unset	The unset log level.
Debug	The debug log level.
Info	The info log level.
Warn	The warn log level.
Error	The error log level.
Fatal	The fatal log level.

Definition at line 95 of file logger.hpp.

Member Function Documentation

◆ get_child()

RCLCPP_PUBLIC Logger rclcpp::Logger::get_child ( const std::string & suffix )

inline

Return a logger that is a descendant of this logger.

The child logger's full name will include any hierarchy conventions that indicate it is a descendant of this logger. For example, get_logger('abc').get_child('def') will return a logger with name abc.def.

Parameters

[in] suffix the child logger's suffix

Returns: a logger with the fully-qualified name including the suffix, or; a dummy logger if this logger is invalid (e.g. because logging is disabled).

Definition at line 160 of file logger.hpp.

Referenced by rclcpp::PublisherBase::PublisherBase(), and rclcpp::SubscriptionBase::SubscriptionBase().

Here is the caller graph for this function:

◆ get_name()

RCLCPP_PUBLIC const char* rclcpp::Logger::get_name ( ) const

inline

Get the name of this logger.

Returns: the full name of the logger including any prefixes, or; nullptr if this logger is invalid (e.g. because logging is disabled).

Definition at line 138 of file logger.hpp.

Referenced by set_level().

Here is the caller graph for this function:

◆ set_level()

void rclcpp::Logger::set_level ( Level level )

Set level for current logger.

Parameters

[in] level the logger's level

Exceptions

rclcpp::exceptions::RCLInvalidArgument	if level is invalid.
rclcpp::exceptions::RCLError	if other error happens.

Definition at line 66 of file logger.cpp.

References get_name(), RCL_RET_ERROR, and RCL_RET_INVALID_ARGUMENT.

Here is the call graph for this function:

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

rclcpp/include/rclcpp/logger.hpp
rclcpp/src/rclcpp/logger.cpp

Public Types

Public Member Functions