eagine::named_logging_object< BackendGetter > Class Template Reference

Basic template for logging objects. More...

#include <eagine/logging/logger.hpp>

Public Types
template<log_event_severity severity>
using	entry_type = std::conditional_t< is_log_level_enabled_v< severity >, log_entry, no_log_entry >
	The entry type for the specified log_event_severity. More...
Public Types inherited from eagine::basic_logger< BackendGetter >
template<log_event_severity severity>
using	entry_type = std::conditional_t< is_log_level_enabled_v< severity >, log_entry, no_log_entry >
	The entry type for the specified log_event_severity. More...

Public Member Functions
	named_logging_object (identifier id, BackendGetter backend_getter) noexcept
	Constructor from identifier and backend_getter object. More...
	named_logging_object (identifier id, const named_logging_object &parent) noexcept
	Constructor from logger id and parent logging object.
	named_logging_object () noexcept=default
	Construct logging object without backend.
	named_logging_object (named_logging_object &&temp) noexcept
	Move constructor.
	named_logging_object (const named_logging_object &that) noexcept
	Copy constructor.
auto	operator= (named_logging_object &&) noexcept -> named_logging_object &=default
	Move assignment operator.
auto	operator= (const named_logging_object &) -> named_logging_object &=default
	Copy assignment operator.
constexpr auto	object_id () const noexcept
	Returns the identifier of this logging object.
void	object_description (string_view display_name, string_view description) noexcept
	Sets the human-readable name and description of this object.
auto	log_fatal (string_view format) noexcept
	Create a log message entry for fatal error, with specified format. More...
auto	log_error (string_view format) noexcept
	Create a log message entry for error, with specified format. More...
auto	log_warning (string_view format) noexcept
	Create a log message entry for warning, with specified format. More...
auto	log_info (string_view format) noexcept
	Create a log message entry for information, with specified format. More...
auto	log_stat (string_view format) noexcept
	Create a log message entry for statistic, with specified format. More...
auto	log_debug (string_view format) noexcept
	Create a log message entry for debugging, with specified format. More...
auto	log_trace (string_view format) noexcept
	Create a log message entry for tracing, with specified format. More...
auto	log_backtrace (string_view format) noexcept
	Create a log message entry for backtracing, with specified format. More...
auto	log_debug_stream () noexcept
	Returns a log entry stream for debug messages. More...
auto	log_error_stream () noexcept
	Returns a log entry stream for error messages. More...
auto	log_chart_sample (identifier series, float value) noexcept -> named_logging_object &
	Stores a new value in the specified chart data series.
template<typename T , typename U >
auto	log_chart_sample (identifier series, const tagged_quantity< T, U > &qty) noexcept -> std::enable_if_t< std::is_convertible_v< T, float >, named_logging_object & >
	Stores a new value in the specified chart data series.
template<typename T , typename P >
auto	log_chart_sample (identifier series, const valid_if< T, P > &opt_value) noexcept -> named_logging_object &
	Stores a new value in the specified chart data series.
Public Member Functions inherited from eagine::basic_logger< BackendGetter >
auto	backend () noexcept
	Returns a pointer to the backend of this logger object.
auto	instance_id () const noexcept -> logger_instance_id
	Returns the unique id of this logger instance.

Detailed Description

template<typename BackendGetter>
class eagine::named_logging_object< BackendGetter >

Basic template for logging objects.

See also

logger

This class is used as the base class for other classes that need to do logging. Prefer using this class instead of logger in such cases.

Member Typedef Documentation

entry_type

template<typename BackendGetter >

template<log_event_severity severity>

using eagine::named_logging_object< BackendGetter >::entry_type = std:: conditional_t<is_log_level_enabled_v<severity>, log_entry, no_log_entry>

The entry type for the specified log_event_severity.

See also

log_entry

no_log_entry

Constructor & Destructor Documentation

named_logging_object()

template<typename BackendGetter >

eagine::named_logging_object< BackendGetter >::named_logging_object ( identifier  id, BackendGetter  backend_getter  )

inlinenoexcept

Constructor from identifier and backend_getter object.

Note

For internal use-only.

Member Function Documentation

log_backtrace()

template<typename BackendGetter >

auto eagine::named_logging_object< BackendGetter >::log_backtrace ( string_view  format )

inlinenoexcept

Create a log message entry for backtracing, with specified format.

See also

log_event_severity

log_debug()

template<typename BackendGetter >

auto eagine::named_logging_object< BackendGetter >::log_debug ( string_view  format )

inlinenoexcept

Create a log message entry for debugging, with specified format.

See also

log_event_severity

log_debug_stream()

template<typename BackendGetter >

auto eagine::named_logging_object< BackendGetter >::log_debug_stream ( )

inlinenoexcept

Returns a log entry stream for debug messages.

See also

log_event_severity

stream_log_entry

log_error()

template<typename BackendGetter >

auto eagine::named_logging_object< BackendGetter >::log_error ( string_view  format )

inlinenoexcept

Create a log message entry for error, with specified format.

See also

log_event_severity

log_error_stream()

template<typename BackendGetter >

auto eagine::named_logging_object< BackendGetter >::log_error_stream ( )

inlinenoexcept

Returns a log entry stream for error messages.

See also

log_event_severity

stream_log_entry

log_fatal()

template<typename BackendGetter >

auto eagine::named_logging_object< BackendGetter >::log_fatal ( string_view  format )

inlinenoexcept

Create a log message entry for fatal error, with specified format.

See also

log_event_severity

log_info()

template<typename BackendGetter >

auto eagine::named_logging_object< BackendGetter >::log_info ( string_view  format )

inlinenoexcept

Create a log message entry for information, with specified format.

See also

log_event_severity

log_stat()

template<typename BackendGetter >

auto eagine::named_logging_object< BackendGetter >::log_stat ( string_view  format )

inlinenoexcept

Create a log message entry for statistic, with specified format.

See also

log_event_severity

log_trace()

template<typename BackendGetter >

auto eagine::named_logging_object< BackendGetter >::log_trace ( string_view  format )

inlinenoexcept

Create a log message entry for tracing, with specified format.

See also

log_event_severity

log_warning()

template<typename BackendGetter >

auto eagine::named_logging_object< BackendGetter >::log_warning ( string_view  format )

inlinenoexcept

Create a log message entry for warning, with specified format.

See also

log_event_severity

---

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

• eagine/logging/logger.hpp