pid Namespace Reference

root namespace for pid packages. More...

Namespaces
	log
	pid::log global namespace for pid-log objects

Classes
class	align_on

Functions
PID_LOG_PID_LOG_EXPORT pid::log::Logger &	logger ()
	access to the global logger object More...
PID_LOG_PID_LOG_EXPORT pid::log::Proxy &	flush (pid::log::Proxy &logger)
	pid::flush flush the output of a logger proxy.. More...
PID_LOG_PID_LOG_EXPORT pid::log::Proxy &	endl (pid::log::Proxy &logger)
	pid::endl insert a new without flushing the output, unlike std::endl. Padding spaces will be inserted after the new line if automatic alignment is activated (i.e. align_on was called). More...
PID_LOG_PID_LOG_EXPORT pid::log::Proxy &	align_off (pid::log::Proxy &logger)
	pid::align_off all lines of the output will be NOT automatically aligned with same padding spaces. More...
PID_LOG_PID_LOG_EXPORT pid::log::Proxy &	debug (pid::log::Proxy &logger)
	pid::debug write the output message as a debug message. More...
PID_LOG_PID_LOG_EXPORT pid::log::Proxy &	info (pid::log::Proxy &logger)
	pid::info write the output message as an informational message. More...
PID_LOG_PID_LOG_EXPORT pid::log::Proxy &	warning (pid::log::Proxy &logger)
	pid::warning write the output message as a warning alert. More...
PID_LOG_PID_LOG_EXPORT pid::log::Proxy &	error (pid::log::Proxy &logger)
	pid::error write the output message as an error. More...
PID_LOG_PID_LOG_EXPORT pid::log::Proxy &	critical (pid::log::Proxy &logger)
	pid::critical write the output message as a critical error (something that cannot be repaired). More...

Detailed Description

root namespace for pid packages.

root namespace for common and general purpose packages.

Function Documentation

align_off()

PID_LOG_PID_LOG_EXPORT pid::log::Proxy& pid::align_off

(

pid::log::Proxy &

logger

)

pid::align_off all lines of the output will be NOT automatically aligned with same padding spaces.

Parameters

logger

The logger proxy to work with.

Returns

The input logger proxy

critical()

PID_LOG_PID_LOG_EXPORT pid::log::Proxy& pid::critical

(

pid::log::Proxy &

logger

)

pid::critical write the output message as a critical error (something that cannot be repaired).

Parameters

logger

The logger proxy to work with.

Returns

The input logger proxy

Examples

ex_log.cpp, and ex_log_hand_written.cpp.

debug()

PID_LOG_PID_LOG_EXPORT pid::log::Proxy& pid::debug

(

pid::log::Proxy &

logger

)

pid::debug write the output message as a debug message.

Parameters

logger

The logger proxy to work with.

Returns

The input logger proxy

Examples

ex_log.cpp, and ex_log_hand_written.cpp.

endl()

PID_LOG_PID_LOG_EXPORT pid::log::Proxy& pid::endl

(

pid::log::Proxy &

logger

)

pid::endl insert a new without flushing the output, unlike std::endl. Padding spaces will be inserted after the new line if automatic alignment is activated (i.e. align_on was called).

Parameters

logger

The logger proxy to work with.

Returns

The input logger proxy

Examples

ex_log.cpp, ex_log_hand_written.cpp, and ex_log_with_threads.cpp.

error()

PID_LOG_PID_LOG_EXPORT pid::log::Proxy& pid::error

(

pid::log::Proxy &

logger

)

pid::error write the output message as an error.

Parameters

logger

The logger proxy to work with.

Returns

The input logger proxy

Examples

ex_log.cpp, ex_log_hand_written.cpp, and ex_log_with_threads.cpp.

flush()

PID_LOG_PID_LOG_EXPORT pid::log::Proxy& pid::flush

(

pid::log::Proxy &

logger

)

pid::flush flush the output of a logger proxy..

Parameters

logger

The logger proxy to work with.

Returns

The input logger proxy

Examples

ex_log.cpp, ex_log_hand_written.cpp, and ex_log_with_threads.cpp.

info()

PID_LOG_PID_LOG_EXPORT pid::log::Proxy& pid::info

(

pid::log::Proxy &

logger

)

pid::info write the output message as an informational message.

Parameters

logger

The logger proxy to work with.

Returns

The input logger proxy

Examples

ex_log.cpp, ex_log_hand_written.cpp, and ex_log_with_threads.cpp.

logger()

PID_LOG_PID_LOG_EXPORT pid::log::Logger& pid::logger

(

)

access to the global logger object

Returns

reference on the global logger object

Examples

ex_log.cpp.

warning()

PID_LOG_PID_LOG_EXPORT pid::log::Proxy& pid::warning

(

pid::log::Proxy &

logger

)

pid::warning write the output message as a warning alert.

Parameters

logger

The logger proxy to work with.

Returns

The input logger proxy

Examples

ex_log.cpp, ex_log_hand_written.cpp, and ex_log_with_threads.cpp.