Orxonox  0.0.5 Codename: Arcturus
Public Member Functions | Protected Types | Protected Attributes | Static Private Attributes | Friends | List of all members
orxonox::DynLibManager Class Reference

Manager for Dynamic-loading Libraries. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/libraries/core/module/DynLibManager.h>

Inheritance diagram for orxonox::DynLibManager:
orxonox::Singleton< T >

Public Member Functions

 DynLibManager ()
 Default constructor. More...
 
virtual ~DynLibManager ()
 Default destructor. More...
 
DynLibload (const std::string &filename)
 Loads the passed library. More...
 
void unload (DynLib *lib)
 Unloads the passed library. More...
 

Protected Types

typedef std::map< std::string, DynLib * > DynLibList
 

Protected Attributes

DynLibList mLibList
 

Static Private Attributes

static DynLibManagersingletonPtr_s = nullptr
 Static pointer to the singleton. More...
 

Friends

class Singleton< DynLibManager >
 

Additional Inherited Members

- Static Public Member Functions inherited from orxonox::Singleton< T >
static bool exists ()
 Tells whether the singleton has been created. More...
 
static T & getInstance ()
 Returns a reference to the singleton instance. More...
 
- Protected Member Functions inherited from orxonox::Singleton< T >
 Singleton ()
 Constructor sets the singleton instance pointer. More...
 
virtual ~Singleton ()
 Destructor resets the singleton instance pointer. More...
 

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.

Member Typedef Documentation

typedef std::map<std::string, DynLib*> orxonox::DynLibManager::DynLibList
protected

Constructor & Destructor Documentation

orxonox::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
orxonox::DynLibManager::~DynLibManager ( )
virtual

Default destructor.

See also
Root::~Root

Member Function Documentation

DynLib * orxonox::DynLibManager::load ( const std::string &  filename)

Loads the passed library.

Parameters
filenameThe name of the library. The extension can be omitted
void orxonox::DynLibManager::unload ( DynLib lib)

Unloads the passed library.

Parameters
libA pointer to the library object

Friends And Related Function Documentation

friend class Singleton< DynLibManager >
friend

Member Data Documentation

DynLibList orxonox::DynLibManager::mLibList
protected
DynLibManager * orxonox::DynLibManager::singletonPtr_s = nullptr
staticprivate

Static pointer to the singleton.


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