Warnings Class Reference

#include <Warnings.hpp>

Collaboration diagram for Warnings:

Public Member Functions
void	AddWarning (const std::string &rMessage, const std::string &rFilename, unsigned lineNumber, bool onlyOnce=false)
std::string	PopWarning () const
unsigned	GetNumWarnings ()
std::string	GetNextWarningMessage ()
Static Public Member Functions
static void	NoisyDestroy ()
static void	QuietDestroy ()
static Warnings *	Instance ()
Protected Member Functions
	Warnings ()
Private Types
typedef std::deque< std::pair < std::string, std::string > >	WarningsContainerType
Private Attributes
WarningsContainerType	mWarningMessages
Static Private Attributes
static Warnings *	mpInstance = NULL

Detailed Description

The Warnings singleton class collects warnings via the AddWarning() method or the WARNING macro. This is to provide a mechanism for informing the user of error which are less severe than those demanding exceptions or assertions. (Errors which can be repaired immediately.)

Warnings can be polled with GetNumWarnings() and GetNextWarningMessage(). Warnings can be ignored and destroyed with QuietDestroy(). All warnings left at the close of the test suite (not the individual test), or the close of the executable, will be printed to the screen.

Definition at line 47 of file Warnings.hpp.

Member Typedef Documentation

typedef std::deque<std::pair<std::string, std::string> > Warnings::WarningsContainerType [private]

Container type for warnings

Definition at line 54 of file Warnings.hpp.

Constructor & Destructor Documentation

Warnings::Warnings ( ) [protected]

Protected constructor. Use Instance() to access the Warnings singleton.

Definition at line 39 of file Warnings.cpp.

Referenced by Instance().

Member Function Documentation

void Warnings::AddWarning	(	const std::string &	rMessage,
		const std::string &	rFilename,
		unsigned	lineNumber,
		bool	onlyOnce = `false`
	)

Make a warning with a message string and add it to the list.

Parameters:

	rMessage	the message
	rFilename	which source file threw the exception
	lineNumber	which line number of the source file threw the exception
	onlyOnce	whether to only log the first warning thrown from this location