Spm::Util::Debug Class Reference

#include <debug.h>

List of all members.

Public Types
enum	messageType_e { MESSAGE, WARNING, ERROR }
Public Member Functions
	~Debug ()
void	message (const miniXml::ustring &message, messageType_e type=MESSAGE, const miniXml::ustring &className="", const miniXml::ustring &functionName="", const miniXml::ustring &file="", int line=0)
	Ouput a message.
template<class T>
void	value (const miniXml::ustring &varName, T &value, const miniXml::ustring &className="", const miniXml::ustring &functionName="", const miniXml::ustring &file="", int line=0)
	Ouput the value of a variable.
template<class T>
void	valueNotRef (const miniXml::ustring &varName, T value, const miniXml::ustring &className="", const miniXml::ustring &functionName="", const miniXml::ustring &file="", int line=0)
	Ouput the value of a variable.
template<class Iterator>
void	value (const miniXml::ustring &varName, Iterator beginIterator, Iterator endIterator, const miniXml::ustring &className="", const miniXml::ustring &functionName="", const miniXml::ustring &file="", int line=0)
	Ouput the value of a container.
template<class Iterator>
void	mapValue (const miniXml::ustring &varName, Iterator beginIterator, Iterator endIterator, const miniXml::ustring &className="", const miniXml::ustring &functionName="", const miniXml::ustring &file="", int line=0)
	Ouput the value of a map.
Static Public Member Functions
static boost::shared_ptr< Debug >	create (const miniXml::ustring &project)
	Create a new Debug object.

---

Member Enumeration Documentation

enum Spm::Util::Debug::messageType_e

Enumerator:

MESSAGE
WARNING
ERROR

---

Constructor & Destructor Documentation

Spm::Util::Debug::~Debug

(

)

---

Member Function Documentation

static boost::shared_ptr<Debug> Spm::Util::Debug::create

(

const miniXml::ustring &

project

)

[static]

Create a new Debug object.

Parameters:

project

The project name of the Debug object

Returns:

Debug a Debug object

void Spm::Util::Debug::message	(	const miniXml::ustring &	message,
		messageType_e	type = MESSAGE,
		const miniXml::ustring &	className = "",
		const miniXml::ustring &	functionName = "",
		const miniXml::ustring &	file = "",
		int	line = 0
	)

Ouput a message.

Parameters:

	message	The message to output
	type	The type of the message to output
	className	The name of the class sending the message
	functionName	The name of the function sending the message
	file	The file name
	line	The line

template<class T>

void Spm::Util::Debug::value	(	const miniXml::ustring &	varName,
		T &	value,
		const miniXml::ustring &	className = "",
		const miniXml::ustring &	functionName = "",
		const miniXml::ustring &	file = "",
		int	line = 0
	)			[inline]

Ouput the value of a variable.

Parameters:

	varName	the name of the variable to output
	value	the value of variable
	className	The name of the class sending the message
	functionName	The name of the function sending the message
	file	The file name
	line	The line

template<class T>

void Spm::Util::Debug::valueNotRef	(	const miniXml::ustring &	varName,
		T	value,
		const miniXml::ustring &	className = "",
		const miniXml::ustring &	functionName = "",
		const miniXml::ustring &	file = "",
		int	line = 0
	)			[inline]

Ouput the value of a variable.

Parameters:

	varName	the name of the variable to output
	value	the value of variable
	className	The name of the class sending the message
	functionName	The name of the function sending the message
	file	The file name
	line	The line

template<class Iterator>

void Spm::Util::Debug::value	(	const miniXml::ustring &	varName,
		Iterator	beginIterator,
		Iterator	endIterator,
		const miniXml::ustring &	className = "",
		const miniXml::ustring &	functionName = "",
		const miniXml::ustring &	file = "",
		int	line = 0
	)			[inline]

Ouput the value of a container.

Parameters:

	varName	the name of the container to output
	beginIterator	the first value to ouput
	endIterator	the last value to ouput
	className	The name of the class sending the message
	functionName	The name of the function sending the message
	file	The file name
	line	The line

template<class Iterator>

void Spm::Util::Debug::mapValue	(	const miniXml::ustring &	varName,
		Iterator	beginIterator,
		Iterator	endIterator,
		const miniXml::ustring &	className = "",
		const miniXml::ustring &	functionName = "",
		const miniXml::ustring &	file = "",
		int	line = 0
	)			[inline]

Ouput the value of a map.

Parameters:

	varName	the name of the container to output
	beginIterator	the first value to ouput
	endIterator	the last value to ouput
	className	The name of the class sending the message
	functionName	The name of the function sending the message
	file	The file name
	line	The line

---

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

• /home/elche/Prog/Projects/spm-0.8/src/include/util/debug.h

---