XmLog.h File Reference

Routines for creating and writing to logs and stacking errors. More...

#include <vector>
#include <boost/function.hpp>
#include <boost/scoped_ptr.hpp>
#include <xmscore/misc/Singleton.h>

Go to the source code of this file.

Classes
class	xms::XmLog
	More...

Namespaces
	xmlog

Macros
#define	XM_LOG(A, B)   ::xms::XmLog::Instance().Log(__FILE__, __LINE__, A, B);
	Log message which can have a log type (Debug, Stackable, Gui). More...

Typedefs
typedef boost::function< std::string()>	xms::XmLogFilenameCallback
	Callback to return the name of the log file.
typedef std::vector< std::pair< xmlog::MessageTypeEnum, std::string > >	xms::MessageStack
	Container type used to store log messages.

Enumerations
enum	xmlog::MessageTypeEnum { xmlog::info, xmlog::warning, xmlog::error, xmlog::debug }
	Log level for XM_LOG. More...

Detailed Description

Routines for creating and writing to logs and stacking errors.

Copyright

(C) Copyright Aquaveo 2018. Distributed under FreeBSD License (See accompanying file LICENSE or https://aqaveo.com/bsd/license.txt)

Definition in file XmLog.h.

Macro Definition Documentation

XM_LOG

#define XM_LOG	(		A,
			B
	)		::xms::XmLog::Instance().Log(__FILE__, __LINE__, A, B);

Log message which can have a log type (Debug, Stackable, Gui).

Parameters

[in]	A	Message type (see xmlog::MessageTypeEnum).
[in]	B	Message to be logged. Gets converted to a std::string.

See also

xmslog::LogLevelEnum

Definition at line 56 of file XmLog.h.

Referenced by xms::iTest_XM_LOG_debug(), xms::iTest_XM_LOG_gui(), xms::iTest_XM_LOG_stackable(), and xms::XmLog::Log().