gpucalc::Library Class Reference

This class represnt dynamically loaded libraries (DLLs). More...

#include <library.h>

Inheritance diagram for gpucalc::Library:

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.
LIBRARY_HANDLE	getSymbol (const std::string &SymbolName) const
	Get symbol from this library.
bool	isLoaded () const
bool	isLocked () const
	returns state of object.
	Library (const std::string &LibraryName)
	Default constructor.
void	load ()
	Loads library.
void	unload ()
	Unloads library.
	~Library ()
Protected Member Functions
void	addSpecificParameter (const std::string &ParameterName, void *ParameterValue, size_t Size)
void	lock ()
void	unlock ()
Private Member Functions
std::string	libraryError () const
Private Attributes
LIBRARY_HANDLE	mhInst
bool	mIsLoaded

---

Detailed Description

This class represnt dynamically loaded libraries (DLLs).

This class can only load and unload DLL, also can get symbols from this library.

Definition at line 78 of file library.h.

---

Constructor & Destructor Documentation

gpucalc::Library::Library

(

const std::string &

LibraryName

)

[inline]

Default constructor.

Parameters:

LibraryName

- path to our library.

Definition at line 91 of file library.h.

                                         :
    Object(_LibraryClassName, LibraryName), mhInst(0), mIsLoaded(false)
   {
   }

gpucalc::Library::~Library

(

)

[inline]

Definition at line 97 of file library.h.

   {
    if (mIsLoaded)
    {
     unload();
    }
   }

---

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__);
    }
   }

LIBRARY_HANDLE gpucalc::Library::getSymbol

(

const std::string &

SymbolName

)

const

Get symbol from this library.

Parameters:

SymbolName

- name of returned symbol in Library.

Definition at line 88 of file library.cpp.

 {
  LogManager::getSingleton().logMessage(this, "Exporting symbol \"" + SymbolName + "\"...", LML_Trivial);
  return (LIBRARY_HANDLE)LIBRARY_GETSYM(mhInst, SymbolName.c_str());
 }

bool gpucalc::Library::isLoaded

(

)

const [inline]

Definition at line 122 of file library.h.

   {
    return mIsLoaded;
   }

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;
   }

std::string gpucalc::Library::libraryError

(

)

const [private]

Definition at line 95 of file library.cpp.

 {
#if PLATFORM == PLATFORM_WIN32
  LPVOID lpMsgBuf;
  FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
   0, GetLastError(), MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (LPTSTR) &lpMsgBuf, 0, 0);
  std::string ret = (char*)lpMsgBuf;
        // Free the buffer.
  LocalFree( lpMsgBuf );
  return ret;
#elif OGRE_PLATFORM == OGRE_PLATFORM_LINUX
  return std::string(dlerror());
#elif OGRE_PLATFORM == OGRE_PLATFORM_APPLE
  return std::string(mac_errorBundle());
#else
  return std::string("");
#endif
 }

void gpucalc::Library::load

(

)

Loads library.

Path to this library sets in constructor Library::Library()

Definition at line 57 of file library.cpp.

 {
  std::string name = this->getObjectName();
#  if PLATFORM == PLATFORM_LINUX
  if (name.substr(name.length() - 3, 3) != ".so")
   name += ".so";
#  endif

  mhInst = (LIBRARY_HANDLE)LIBRARY_LOAD(name.c_str());
  if (!mhInst)
  {
   Except<ERR_INTERNAL_ERROR>(this, "Could not load dynamic library \"" + name + "\". System Error: " + libraryError(),
    "DynLib::load", __FILE__, __LINE__);
  }

  LogManager::getSingleton().logMessage(this, "Library loaded.", LML_Trivial);
  mIsLoaded = true;
 }

void gpucalc::Object::lock

(

)

[inline, protected, inherited]

Definition at line 265 of file object.h.

   {
    mIsLocked = true;
   }

void gpucalc::Library::unload

(

)

Unloads library.

Path to this library sets in constructor Library::Library()

Definition at line 77 of file library.cpp.

 {
  if (LIBRARY_UNLOAD(mhInst))
  {
   Except<ERR_INTERNAL_ERROR>(this, "Could not unload dynamic library \"" + this->getObjectName() + "\". System Error: " + libraryError(),
    "DynLib::unload", __FILE__, __LINE__);
  }
  LogManager::getSingleton().logMessage(this, "Library unloaded.", LML_Trivial);
  mIsLoaded = false;
 }

void gpucalc::Object::unlock

(

)

[inline, protected, inherited]

Definition at line 271 of file object.h.

   {
    mIsLocked = false;
   }

---

Member Data Documentation

LIBRARY_HANDLE gpucalc::Library::mhInst [private]

Definition at line 137 of file library.h.

bool gpucalc::Library::mIsLoaded [private]

Definition at line 143 of file library.h.

---

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

• gpucalc/library.h
• gpucalc/library.cpp