.TH "log4tango::Logger" 3 "Wed Sep 2 2020" "Version 5.0.2" "log4tango" \" -*- nroff -*-
.ad l
.nh
.SH NAME
log4tango::Logger
.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Logger\&.hh>\fP
.PP
Inherits \fBlog4tango::AppenderAttachable\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBLogger\fP (const std::string &name, \fBLevel::Value\fP level=\fBLevel::OFF\fP)"
.br
.RI "Constructor\&. "
.ti -1c
.RI "virtual \fB~Logger\fP ()"
.br
.RI "Destructor\&. "
.ti -1c
.RI "const std::string & \fBget_name\fP () const"
.br
.RI "Return the logger name\&. "
.ti -1c
.RI "void \fBset_level\fP (\fBLevel::Value\fP level)"
.br
.RI "Set the level of this \fBLogger\fP (silently ignores invalid values) "
.ti -1c
.RI "\fBLevel::Value\fP \fBget_level\fP () const"
.br
.RI "Returns the assigned \fBLevel\fP, if any, for this \fBLogger\fP\&. "
.ti -1c
.RI "bool \fBis_level_enabled\fP (\fBLevel::Value\fP level) const"
.br
.RI "Returns true if the level of the \fBLogger\fP is equal to or higher than given level\&. "
.ti -1c
.RI "void \fBlog\fP (\fBLevel::Value\fP level, const char *string_format,\&.\&.\&.)"
.br
.RI "Log a message with the specified level\&. "
.ti -1c
.RI "void \fBlog\fP (\fBLevel::Value\fP level, const std::string &message)"
.br
.RI "Log a message with the specified level\&. "
.ti -1c
.RI "void \fBlog_unconditionally\fP (\fBLevel::Value\fP level, const char *string_format,\&.\&.\&.)"
.br
.RI "Log a message with the specified level without level checking\&. "
.ti -1c
.RI "void \fBlog_unconditionally\fP (\fBLevel::Value\fP level, const std::string &message)"
.br
.RI "Log a message with the specified level without level checking\&. "
.ti -1c
.RI "void \fBdebug\fP (const char *string_format,\&.\&.\&.)"
.br
.RI "Log a message with debug level\&. "
.ti -1c
.RI "void \fBdebug\fP (const std::string &message)"
.br
.RI "Log a message with debug level\&. "
.ti -1c
.RI "bool \fBis_debug_enabled\fP (void) const"
.br
.RI "Return true if the \fBLogger\fP will log messages with level DEBUG\&. "
.ti -1c
.RI "\fBLoggerStream\fP \fBdebug_stream\fP (void)"
.br
.RI "Return a \fBLoggerStream\fP with level DEBUG\&. "
.ti -1c
.RI "void \fBinfo\fP (const char *string_format,\&.\&.\&.)"
.br
.RI "Log a message with info level\&. "
.ti -1c
.RI "void \fBinfo\fP (const std::string &message)"
.br
.RI "Log a message with info level\&. "
.ti -1c
.RI "bool \fBis_info_enabled\fP (void) const"
.br
.RI "Return true if the \fBLogger\fP will log messages with level INFO\&. "
.ti -1c
.RI "\fBLoggerStream\fP \fBinfo_stream\fP (void)"
.br
.RI "Return a \fBLoggerStream\fP with level INFO\&. "
.ti -1c
.RI "void \fBwarn\fP (const char *string_format,\&.\&.\&.)"
.br
.RI "Log a message with warn level\&. "
.ti -1c
.RI "void \fBwarn\fP (const std::string &message)"
.br
.RI "Log a message with warn level\&. "
.ti -1c
.RI "bool \fBis_warn_enabled\fP (void) const"
.br
.RI "Return true if the \fBLogger\fP will log messages with level WARN\&. "
.ti -1c
.RI "\fBLoggerStream\fP \fBwarn_stream\fP (void)"
.br
.RI "Return a \fBLoggerStream\fP with level WARN\&. "
.ti -1c
.RI "void \fBerror\fP (const char *string_format,\&.\&.\&.)"
.br
.RI "Log a message with error level\&. "
.ti -1c
.RI "void \fBerror\fP (const std::string &message)"
.br
.RI "Log a message with error level\&. "
.ti -1c
.RI "bool \fBis_error_enabled\fP (void) const"
.br
.RI "Return true if the \fBLogger\fP will log messages with level ERROR\&. "
.ti -1c
.RI "\fBLoggerStream\fP \fBerror_stream\fP (void)"
.br
.RI "Return a \fBLoggerStream\fP with level ERROR\&. "
.ti -1c
.RI "void \fBfatal\fP (const char *string_format,\&.\&.\&.)"
.br
.RI "Log a message with fatal level\&. "
.ti -1c
.RI "void \fBfatal\fP (const std::string &message)"
.br
.RI "Log a message with fatal level\&. "
.ti -1c
.RI "bool \fBis_fatal_enabled\fP (void) const"
.br
.RI "Return true if the \fBLogger\fP will log messages with level FATAL\&. "
.ti -1c
.RI "\fBLoggerStream\fP \fBfatal_stream\fP (void)"
.br
.RI "Return a \fBLoggerStream\fP with level FATAL\&. "
.ti -1c
.RI "\fBLoggerStream\fP \fBget_stream\fP (\fBLevel::Value\fP level, bool filter=true)"
.br
.RI "Return a \fBLoggerStream\fP with given \fBLevel\fP\&. "
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBcall_appenders\fP (const \fBLoggingEvent\fP &event)"
.br
.RI "Call the appenders\&. "
.in -1c
.SS "Additional Inherited Members"
.SH "Constructor & Destructor Documentation"
.PP 
.SS "log4tango::Logger::Logger (const std::string & name, \fBLevel::Value\fP level = \fC\fBLevel::OFF\fP\fP)"

.PP
Constructor\&. 
.PP
\fBParameters\fP
.RS 4
\fIname\fP the fully qualified name of this \fBLogger\fP 
.br
\fIlevel\fP the level for this \fBLogger\fP\&. Defaults to \fBLevel::OFF\fP 
.RE
.PP

.SS "log4tango::Logger::~Logger ()\fC [virtual]\fP"

.PP
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "void log4tango::Logger::call_appenders (const \fBLoggingEvent\fP & event)\fC [protected]\fP"

.PP
Call the appenders\&. 
.PP
\fBParameters\fP
.RS 4
\fIevent\fP the LogginEvent to log\&. 
.RE
.PP

.SS "void log4tango::Logger::debug (const char * string_format,  \&.\&.\&.)"

.PP
Log a message with debug level\&. 
.PP
\fBParameters\fP
.RS 4
\fIstring_format\fP Format specifier for the log\&. 
.br
\fI\&.\&.\&.\fP The arguments for string_format 
.RE
.PP

.SS "void log4tango::Logger::debug (const std::string & message)\fC [inline]\fP"

.PP
Log a message with debug level\&. 
.PP
\fBParameters\fP
.RS 4
\fImessage\fP string to write in the log file 
.RE
.PP

.SS "\fBLoggerStream\fP log4tango::Logger::debug_stream (void)\fC [inline]\fP"

.PP
Return a \fBLoggerStream\fP with level DEBUG\&. 
.PP
\fBReturns\fP
.RS 4
The \fBLoggerStream\fP\&. 
.RE
.PP

.SS "void log4tango::Logger::error (const char * string_format,  \&.\&.\&.)"

.PP
Log a message with error level\&. 
.PP
\fBParameters\fP
.RS 4
\fIstring_format\fP Format specifier for the log\&. 
.br
\fI\&.\&.\&.\fP The arguments for string_format 
.RE
.PP

.SS "void log4tango::Logger::error (const std::string & message)\fC [inline]\fP"

.PP
Log a message with error level\&. 
.PP
\fBParameters\fP
.RS 4
\fImessage\fP string to write in the log file 
.RE
.PP

.SS "\fBLoggerStream\fP log4tango::Logger::error_stream (void)\fC [inline]\fP"

.PP
Return a \fBLoggerStream\fP with level ERROR\&. 
.PP
\fBReturns\fP
.RS 4
The \fBLoggerStream\fP\&. 
.RE
.PP

.SS "void log4tango::Logger::fatal (const char * string_format,  \&.\&.\&.)"

.PP
Log a message with fatal level\&. 
.PP
\fBParameters\fP
.RS 4
\fIstring_format\fP Format specifier for the log\&. 
.br
\fI\&.\&.\&.\fP The arguments for string_format 
.RE
.PP

.SS "void log4tango::Logger::fatal (const std::string & message)\fC [inline]\fP"

.PP
Log a message with fatal level\&. 
.PP
\fBParameters\fP
.RS 4
\fImessage\fP string to write in the log file 
.RE
.PP

.SS "\fBLoggerStream\fP log4tango::Logger::fatal_stream (void)\fC [inline]\fP"

.PP
Return a \fBLoggerStream\fP with level FATAL\&. 
.PP
\fBReturns\fP
.RS 4
The \fBLoggerStream\fP\&. 
.RE
.PP

.SS "\fBLevel::Value\fP log4tango::Logger::get_level () const\fC [inline]\fP"

.PP
Returns the assigned \fBLevel\fP, if any, for this \fBLogger\fP\&. 
.PP
\fBReturns\fP
.RS 4
\fBLevel\fP - the assigned \fBLevel\fP, can be Level::NOTSET 
.RE
.PP

.SS "const std::string& log4tango::Logger::get_name () const\fC [inline]\fP"

.PP
Return the logger name\&. 
.PP
\fBReturns\fP
.RS 4
The logger name\&. 
.RE
.PP

.SS "\fBLoggerStream\fP log4tango::Logger::get_stream (\fBLevel::Value\fP level, bool filter = \fCtrue\fP)\fC [inline]\fP"

.PP
Return a \fBLoggerStream\fP with given \fBLevel\fP\&. 
.PP
\fBParameters\fP
.RS 4
\fIlevel\fP The \fBLevel\fP of the \fBLoggerStream\fP\&. 
.br
\fIfilter\fP The filter flag 
.RE
.PP
\fBReturns\fP
.RS 4
The requested \fBLoggerStream\fP\&. 
.RE
.PP

.SS "void log4tango::Logger::info (const char * string_format,  \&.\&.\&.)"

.PP
Log a message with info level\&. 
.PP
\fBParameters\fP
.RS 4
\fIstring_format\fP Format specifier for the log\&. 
.br
\fI\&.\&.\&.\fP The arguments for string_format 
.RE
.PP

.SS "void log4tango::Logger::info (const std::string & message)\fC [inline]\fP"

.PP
Log a message with info level\&. 
.PP
\fBParameters\fP
.RS 4
\fImessage\fP string to write in the log file 
.RE
.PP

.SS "\fBLoggerStream\fP log4tango::Logger::info_stream (void)\fC [inline]\fP"

.PP
Return a \fBLoggerStream\fP with level INFO\&. 
.PP
\fBReturns\fP
.RS 4
The \fBLoggerStream\fP\&. 
.RE
.PP

.SS "bool log4tango::Logger::is_debug_enabled (void) const\fC [inline]\fP"

.PP
Return true if the \fBLogger\fP will log messages with level DEBUG\&. 
.PP
\fBReturns\fP
.RS 4
Whether the \fBLogger\fP will log\&. 
.RE
.PP

.SS "bool log4tango::Logger::is_error_enabled (void) const\fC [inline]\fP"

.PP
Return true if the \fBLogger\fP will log messages with level ERROR\&. 
.PP
\fBReturns\fP
.RS 4
Whether the \fBLogger\fP will log\&. 
.RE
.PP

.SS "bool log4tango::Logger::is_fatal_enabled (void) const\fC [inline]\fP"

.PP
Return true if the \fBLogger\fP will log messages with level FATAL\&. 
.PP
\fBReturns\fP
.RS 4
Whether the \fBLogger\fP will log\&. 
.RE
.PP

.SS "bool log4tango::Logger::is_info_enabled (void) const\fC [inline]\fP"

.PP
Return true if the \fBLogger\fP will log messages with level INFO\&. 
.PP
\fBReturns\fP
.RS 4
Whether the \fBLogger\fP will log\&. 
.RE
.PP

.SS "bool log4tango::Logger::is_level_enabled (\fBLevel::Value\fP level) const\fC [inline]\fP"

.PP
Returns true if the level of the \fBLogger\fP is equal to or higher than given level\&. 
.PP
\fBParameters\fP
.RS 4
\fIlevel\fP The level to compare with\&. 
.RE
.PP
\fBReturns\fP
.RS 4
whether logging is enable for this level\&. 
.RE
.PP

.SS "bool log4tango::Logger::is_warn_enabled (void) const\fC [inline]\fP"

.PP
Return true if the \fBLogger\fP will log messages with level WARN\&. 
.PP
\fBReturns\fP
.RS 4
Whether the \fBLogger\fP will log\&. 
.RE
.PP

.SS "void log4tango::Logger::log (\fBLevel::Value\fP level, const char * string_format,  \&.\&.\&.)"

.PP
Log a message with the specified level\&. 
.PP
\fBParameters\fP
.RS 4
\fIlevel\fP The level of this log message\&. 
.br
\fIstring_format\fP Format specifier for the log \&. 
.br
\fI\&.\&.\&.\fP The arguments for string_format 
.RE
.PP

.SS "void log4tango::Logger::log (\fBLevel::Value\fP level, const std::string & message)\fC [inline]\fP"

.PP
Log a message with the specified level\&. 
.PP
\fBParameters\fP
.RS 4
\fIlevel\fP The level of this log message\&. 
.br
\fImessage\fP string to write in the log file 
.RE
.PP

.SS "void log4tango::Logger::log_unconditionally (\fBLevel::Value\fP level, const char * string_format,  \&.\&.\&.)"

.PP
Log a message with the specified level without level checking\&. 
.PP
\fBParameters\fP
.RS 4
\fIlevel\fP The level of this log message\&. 
.br
\fIstring_format\fP Format specifier for the log \&. 
.br
\fI\&.\&.\&.\fP The arguments for string_format 
.RE
.PP

.SS "void log4tango::Logger::log_unconditionally (\fBLevel::Value\fP level, const std::string & message)"

.PP
Log a message with the specified level without level checking\&. 
.PP
\fBParameters\fP
.RS 4
\fIlevel\fP The level of this log message\&. 
.br
\fImessage\fP string to write in the log file 
.RE
.PP

.SS "void log4tango::Logger::set_level (\fBLevel::Value\fP level)"

.PP
Set the level of this \fBLogger\fP (silently ignores invalid values) 
.PP
\fBParameters\fP
.RS 4
\fIlevel\fP The level to set\&. 
.RE
.PP

.SS "void log4tango::Logger::warn (const char * string_format,  \&.\&.\&.)"

.PP
Log a message with warn level\&. 
.PP
\fBParameters\fP
.RS 4
\fIstring_format\fP Format specifier for the log\&. 
.br
\fI\&.\&.\&.\fP The arguments for string_format 
.RE
.PP

.SS "void log4tango::Logger::warn (const std::string & message)\fC [inline]\fP"

.PP
Log a message with warn level\&. 
.PP
\fBParameters\fP
.RS 4
\fImessage\fP string to write in the log file 
.RE
.PP

.SS "\fBLoggerStream\fP log4tango::Logger::warn_stream (void)\fC [inline]\fP"

.PP
Return a \fBLoggerStream\fP with level WARN\&. 
.PP
\fBReturns\fP
.RS 4
The \fBLoggerStream\fP\&. 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for log4tango from the source code\&.