logger Class Reference

Detailed Description

The singleton class returned by Drake's drake::log() function, offering functions to emit log messages.

Refer to the file overview for details.

#include <drake/common/text_logging.h>

Public Member Functions
template<typename... Args>
void	trace (fmt::format_string< Args... > pattern, Args &&... args)
	Logs a formatted message at trace severity.
template<typename... Args>
void	debug (fmt::format_string< Args... > pattern, Args &&... args)
	Logs a formatted message at debug severity.
template<typename... Args>
void	info (fmt::format_string< Args... > pattern, Args &&... args)
	Logs a formatted message at info severity.
template<typename... Args>
void	warn (fmt::format_string< Args... > pattern, Args &&... args)
	Logs a formatted message at warn severity.
template<typename... Args>
void	error (fmt::format_string< Args... > pattern, Args &&... args)
	Logs a formatted message at error severity.
template<typename... Args>
void	critical (fmt::format_string< Args... > pattern, Args &&... args)
	Logs a formatted message at critical severity.
template<typename StringLike>
void	trace (const StringLike &message)
	Logs a string at trace severity.
template<typename StringLike>
void	debug (const StringLike &message)
	Logs a string at debug severity.
template<typename StringLike>
void	info (const StringLike &message)
	Logs a string at info severity.
template<typename StringLike>
void	warn (const StringLike &message)
	Logs a string at warn severity.
template<typename StringLike>
void	error (const StringLike &message)
	Logs a string at error severity.
template<typename StringLike>
void	critical (const StringLike &message)
	Logs a string at critival severity.
template<typename... Args>
void	log (level_enum severity, fmt::format_string< Args... > pattern, Args &&... args)
	Logs a formatted message at the given severity.
void	log (level_enum severity, std::string_view message)
	Logs a string at the given severity.
bool	should_log (level_enum severity) const
	Returns true iff the current level() threshold meets the given severity.
level_enum	level () const
	Returns the current log level.
void	set_level (level_enum severity) const
	Sets the currently log level.
void	set_pattern (std::string_view pattern)
	Invokes spdlog::logger::set_pattern(pattern).
Does not allow copy, move, or assignment
	logger (const logger &)=delete
logger &	operator= (const logger &)=delete
	logger (logger &&)=delete
logger &	operator= (logger &&)=delete

Friends
logging::logger *	drake::log ()

Constructor & Destructor Documentation

logger() [1/2]

logger ( const logger & )

delete

logger() [2/2]

logger ( logger && )

delete

Member Function Documentation

critical() [1/2]

template<typename StringLike>

void critical

(

const StringLike &

message

)

Logs a string at critival severity.

critical() [2/2]

template<typename... Args>

void critical	(	fmt::format_string< Args... >	pattern,
		Args &&...	args )

Logs a formatted message at critical severity.

debug() [1/2]

template<typename StringLike>

void debug

(

const StringLike &

message

)

Logs a string at debug severity.

debug() [2/2]

template<typename... Args>

void debug	(	fmt::format_string< Args... >	pattern,
		Args &&...	args )

Logs a formatted message at debug severity.

error() [1/2]

template<typename StringLike>

void error

(

const StringLike &

message

)

Logs a string at error severity.

error() [2/2]

template<typename... Args>

void error	(	fmt::format_string< Args... >	pattern,
		Args &&...	args )

Logs a formatted message at error severity.

info() [1/2]

template<typename StringLike>

void info

(

const StringLike &

message

)

Logs a string at info severity.

info() [2/2]

template<typename... Args>

void info	(	fmt::format_string< Args... >	pattern,
		Args &&...	args )

Logs a formatted message at info severity.

level()

level_enum level

(

)

const

Returns the current log level.

log() [1/2]

template<typename... Args>

void log	(	level_enum	severity,
		fmt::format_string< Args... >	pattern,
		Args &&...	args )

Logs a formatted message at the given severity.

log() [2/2]

void log	(	level_enum	severity,
		std::string_view	message )

Logs a string at the given severity.

operator=() [1/2]

logger & operator= ( const logger & )

delete

operator=() [2/2]

logger & operator= ( logger && )

delete

set_level()

void set_level

(

level_enum

severity

)

const

Sets the currently log level.

set_pattern()

void set_pattern

(

std::string_view

pattern

)

Invokes spdlog::logger::set_pattern(pattern).

This has no effect unless spdlog is enabled.

Parameters

pattern

Formatting for message. For more information, see: https://github.com/gabime/spdlog/wiki/3.-Custom-formatting

should_log()

bool should_log

(

level_enum

severity

)

const

Returns true iff the current level() threshold meets the given severity.

trace() [1/2]

template<typename StringLike>

void trace

(

const StringLike &

message

)

Logs a string at trace severity.

trace() [2/2]

template<typename... Args>

void trace	(	fmt::format_string< Args... >	pattern,
		Args &&...	args )

Logs a formatted message at trace severity.

warn() [1/2]

template<typename StringLike>

void warn

(

const StringLike &

message

)

Logs a string at warn severity.

warn() [2/2]

template<typename... Args>

void warn	(	fmt::format_string< Args... >	pattern,
		Args &&...	args )

Logs a formatted message at warn severity.

Friends And Related Symbol Documentation

drake::log

logging::logger * drake::log ( )

friend

---

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

• drake/common/text_logging.h