Ogre::DynLibManager Class Reference

Manager for Dynamic-loading Libraries. More...

#include <OgreDynLibManager.h>

Inheritance diagram for Ogre::DynLibManager:

Public Member Functions
	DynLibManager ()
	Default constructor.
virtual	~DynLibManager ()
	Default destructor.
DynLib *	load (const String &filename)
	Loads the passed library.
void	operator delete (void *ptr)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete (void *ptr, void *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
void *	operator new (size_t sz)
void *	operator new (size_t sz, const char *file, int line, const char *func)
	operator new, with debug line info
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info
void	unload (DynLib *lib)
	Unloads the passed library.

Static Public Member Functions
static DynLibManager &	getSingleton (void)
	Override standard Singleton retrieval.
static DynLibManager *	getSingletonPtr (void)
	Override standard Singleton retrieval.

Protected Types
typedef map< String, DynLib * >::type	DynLibList

Protected Attributes
DynLibList	mLibList

Static Protected Attributes
static DynLibManager *	msSingleton

Detailed Description

Manager for Dynamic-loading Libraries.

Remarks

This manager keeps a track of all the open dynamic-loading libraries, opens them and returns references to already-open libraries.

Definition at line 48 of file OgreDynLibManager.h.

Member Typedef Documentation

DynLibList

typedef map<String,DynLib*>::type Ogre::DynLibManager::DynLibList

protected

Definition at line 51 of file OgreDynLibManager.h.

Constructor & Destructor Documentation

DynLibManager()

Ogre::DynLibManager::DynLibManager

(

)

Default constructor.

Note

Should never be called as the singleton is automatically created during the creation of the Root object.

See also

Root::Root

Referenced by getSingleton(), and getSingletonPtr().

~DynLibManager()

virtual Ogre::DynLibManager::~DynLibManager ( )

virtual

Default destructor.

See also

Root::~Root

Member Function Documentation

getSingleton()

DynLibManager & Ogre::DynLibManager::getSingleton ( void )

static

Override standard Singleton retrieval.

Remarks

Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

References DynLibManager().

getSingletonPtr()

DynLibManager * Ogre::DynLibManager::getSingletonPtr ( void )

static

Override standard Singleton retrieval.

Remarks

Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

References DynLibManager().

load()

DynLib * Ogre::DynLibManager::load

(

const String &

filename

)

Loads the passed library.

Parameters

filename

The name of the library. The extension can be omitted.

operator delete() [1/3]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete ( void * ptr )

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

operator delete() [2/3]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete ( void * ptr, const char * , int , const char *  )

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

operator delete() [3/3]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete ( void * ptr, void *  )

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

operator delete[]() [1/2]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete[] ( void * ptr )

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

operator delete[]() [2/2]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete[] ( void * ptr, const char * , int , const char *  )

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

operator new() [1/3]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new ( size_t sz )

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

operator new() [2/3]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new ( size_t sz, const char * file, int line, const char * func )

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

operator new() [3/3]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new ( size_t sz, void * ptr )

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

operator new[]() [1/2]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new[] ( size_t sz )

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

operator new[]() [2/2]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new[] ( size_t sz, const char * file, int line, const char * func )

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

unload()

void Ogre::DynLibManager::unload

(

DynLib *

lib

)

Unloads the passed library.

Parameters

lib	The library.

Member Data Documentation

mLibList

DynLibList Ogre::DynLibManager::mLibList

protected

Definition at line 52 of file OgreDynLibManager.h.

msSingleton

DynLibManager* Ogre::Singleton< DynLibManager >::msSingleton

staticprotectedinherited

Definition at line 75 of file OgreSingleton.h.

---

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

• OgreDynLibManager.h