gpucalc::Object Class Reference

Base class in our class ierarchy. More...

#include <object.h>

Inheritance diagram for gpucalc::Object:

Inheritance graph

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.
 Object (const std::string &ClassName, const std::string &ObjectName)
virtual ~Object ()

Protected Member Functions

void addSpecificParameter (const std::string &ParameterName, void *ParameterValue, size_t Size)
void lock ()
void unlock ()

Private Types

typedef std::map< std::string,
Any
SpecificParametersMap

Private Attributes

std::string mClassName
bool mIsLocked
std::string mObjectName
SpecificParametersMap mSpecificParameters

Classes

class  Any


Detailed Description

Base class in our class ierarchy.

Provides methods for returning object name, class name.

Definition at line 68 of file object.h.


Member Typedef Documentation

typedef std::map<std::string, Any> gpucalc::Object::SpecificParametersMap [private]

Definition at line 243 of file object.h.


Constructor & Destructor Documentation

gpucalc::Object::Object ( const std::string &  ClassName,
const std::string &  ObjectName 
) [inline]

Definition at line 73 of file object.h.

00073                                                                     : mClassName(ClassName), mObjectName(ObjectName), mSpecificParameters(),
00074     mIsLocked(false)
00075    {
00076    }

virtual gpucalc::Object::~Object (  )  [inline, virtual]

Definition at line 79 of file object.h.

00080    {
00081     /*for (SpecificParametersMap::iterator i = mSpecificParameters.begin(); i != mSpecificParameters.end(); ++i)
00082     {
00083      free(i->second.Pointer);
00084     }
00085     */
00086    }


Member Function Documentation

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

Definition at line 254 of file object.h.

00255    {
00256     SpecificParametersMap::iterator i = mSpecificParameters.find(ParameterName);
00257     if (i != mSpecificParameters.end())
00258     {
00259      mSpecificParameters.erase(i);
00260     }
00261     mSpecificParameters[ParameterName] = Any(ParameterValue, Size);
00262    }

const std::string& gpucalc::Object::getClassName (  )  const [inline]

Returns name of class of our object.

Definition at line 92 of file object.h.

00093    {
00094     return mClassName;
00095    }

const std::string& gpucalc::Object::getObjectName (  )  const [inline]

Returns name of our object.

Definition at line 101 of file object.h.

00102    {
00103     return mObjectName;
00104    }

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

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.

00129    {
00130     SpecificParametersMap::iterator i = mSpecificParameters.find(ParameterName);
00131     if (i != mSpecificParameters.end())
00132     {
00133      i->second.copyValue(ParameterValue);
00134     }
00135     else
00136     {
00137      Except<ERR_ITEM_NOT_FOUND>(this, "Parameter \"" + ParameterName + "\" does not exists.", "Object::getSpecificParameter()", __FILE__, __LINE__);
00138     }
00139    }

bool gpucalc::Object::isLocked (  )  const [inline]

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.

00114    {
00115     return mIsLocked;
00116    }

void gpucalc::Object::lock (  )  [inline, protected]

Definition at line 265 of file object.h.

00266    {
00267     mIsLocked = true;
00268    }

void gpucalc::Object::unlock (  )  [inline, protected]

Definition at line 271 of file object.h.

00272    {
00273     mIsLocked = false;
00274    }


Member Data Documentation

std::string gpucalc::Object::mClassName [private]

Definition at line 143 of file object.h.

Definition at line 247 of file object.h.

std::string gpucalc::Object::mObjectName [private]

Definition at line 144 of file object.h.

Definition at line 244 of file object.h.


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

Generated on Thu Mar 5 22:36:45 2009 for gpucalc by  doxygen 1.5.6