gpucalc::LogListener Class Reference

Pure abstract class, derive this class and register to the Log to listen to log messages. More...

#include <log.h>

Inheritance diagram for gpucalc::LogListener:

List of all members.

Public Member Functions
const std::string &	getClassName () const
	Returns name of class of our object.
const std::string &	getObjectName () const
	Returns name of our object.
void	getSpecificParameter (const std::string &ParameterName, void *ParameterValue)
	Method for obtaining some specific parameters, such as texture specific params, and so on.
bool	isLocked () const
	returns state of object.
	LogListener (const std::string &LogListenerName)
virtual void	MessageLogged (const std::string &message, LogMessageLevel lml, bool maskDebug, const std::string &logName)=0
virtual	~LogListener ()
Protected Member Functions
void	addSpecificParameter (const std::string &ParameterName, void *ParameterValue, size_t Size)
void	lock ()
void	unlock ()

---

Detailed Description

Pure abstract class, derive this class and register to the Log to listen to log messages.

Definition at line 77 of file log.h.

---

Constructor & Destructor Documentation

gpucalc::LogListener::LogListener

(

const std::string &

LogListenerName

)

[inline]

Definition at line 81 of file log.h.

                                                 : Object(_LogListenerClassName, LogListenerName)
   {}

virtual gpucalc::LogListener::~LogListener

(

)

[inline, virtual]

Definition at line 84 of file log.h.

   {
   }

---

Member Function Documentation

void gpucalc::Object::addSpecificParameter	(	const std::string &	ParameterName,
		void *	ParameterValue,
		size_t	Size
	)			[inline, protected, inherited]

Definition at line 254 of file object.h.

   {
    SpecificParametersMap::iterator i = mSpecificParameters.find(ParameterName);
    if (i != mSpecificParameters.end())
    {
     mSpecificParameters.erase(i);
    }
    mSpecificParameters[ParameterName] = Any(ParameterValue, Size);
   }

const std::string& gpucalc::Object::getClassName

(

)

const [inline, inherited]

Returns name of class of our object.

Definition at line 92 of file object.h.

   {
    return mClassName;
   }

const std::string& gpucalc::Object::getObjectName

(

)

const [inline, inherited]

Returns name of our object.

Definition at line 101 of file object.h.

   {
    return mObjectName;
   }

void gpucalc::Object::getSpecificParameter	(	const std::string &	ParameterName,
		void *	ParameterValue
	)			[inline, inherited]

Method for obtaining some specific parameters, such as texture specific params, and so on.

Parameters:

	ParameterName	- name of parameter, usually it similar to specific method of some object (for example, GLTextureID)
	ParameterValue	- contain value of named parameter, it must be allocated and have sufficient size.

Todo:

Think for better realization.

Definition at line 128 of file object.h.

   {
    SpecificParametersMap::iterator i = mSpecificParameters.find(ParameterName);
    if (i != mSpecificParameters.end())
    {
     i->second.copyValue(ParameterValue);
    }
    else
    {
     Except<ERR_ITEM_NOT_FOUND>(this, "Parameter \"" + ParameterName + "\" does not exists.", "Object::getSpecificParameter()", __FILE__, __LINE__);
    }
   }

bool gpucalc::Object::isLocked

(

)

const [inline, inherited]

returns state of object.

If object is locked then we cannot change some state of it, because object is used in computation. If object is unlocked then we can change some state of it, object is not in computation.

Definition at line 113 of file object.h.

   {
    return mIsLocked;
   }

void gpucalc::Object::lock

(

)

[inline, protected, inherited]

Definition at line 265 of file object.h.

   {
    mIsLocked = true;
   }

virtual void gpucalc::LogListener::MessageLogged	(	const std::string &	message,
		LogMessageLevel	lml,
		bool	maskDebug,
		const std::string &	logName
	)			[pure virtual]

Remarks:

This is called whenever the log recieves a message and is about to write it out

Parameters:

	message	The message to be logged
	lml	The message level the log is using
	maskDebug	If we are printing to the console or not
	logName	the name of this log (so you can have several listeners for different logs, and identify them).

void gpucalc::Object::unlock

(

)

[inline, protected, inherited]

Definition at line 271 of file object.h.

   {
    mIsLocked = false;
   }

---

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

• gpucalc/log.h