Orxonox  0.0.5 Codename: Arcturus
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
orxonox::DynLib Class Reference

Resource holding data about a dynamic library. More...

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

Public Member Functions

 DynLib (const std::string &name)
 Default constructor - used by DynLibManager. More...
 
 ~DynLib ()
 Default destructor. More...
 
const std::string & getName (void) const
 Get the name of the library. More...
 
voidgetSymbol (const std::string &strName) const throw ()
 Returns the address of the given symbol from the loaded library. More...
 
void load ()
 Load the library. More...
 
void unload ()
 Unload the library. More...
 

Protected Member Functions

std::string dynlibError (void)
 Gets the last loading error. More...
 

Protected Attributes

DYNLIB_HANDLE m_hInst
 Handle to the loaded library. More...
 
std::string mName
 

Detailed Description

Resource holding data about a dynamic library.

Remarks
This class holds the data required to get symbols from libraries loaded at run-time (i.e. from DLL's for so's)
Author
Adrian Cearnău (cearn.nosp@m.y@ce.nosp@m.arny..nosp@m.ro)
Since
27 January 2002

Constructor & Destructor Documentation

orxonox::DynLib::DynLib ( const std::string &  name)

Default constructor - used by DynLibManager.

Warning
Do not call directly
orxonox::DynLib::~DynLib ( )

Default destructor.

Member Function Documentation

std::string orxonox::DynLib::dynlibError ( void  )
protected

Gets the last loading error.

const std::string& orxonox::DynLib::getName ( void  ) const
inline

Get the name of the library.

void * orxonox::DynLib::getSymbol ( const std::string &  strName) const
throw (
)

Returns the address of the given symbol from the loaded library.

Parameters
strNameThe name of the symbol to search for
Returns
If the function succeeds, the returned value is a handle to the symbol.
If the function fails, the returned value is nullptr.
void orxonox::DynLib::load ( )

Load the library.

void orxonox::DynLib::unload ( )

Unload the library.

Member Data Documentation

DYNLIB_HANDLE orxonox::DynLib::m_hInst
protected

Handle to the loaded library.

std::string orxonox::DynLib::mName
protected

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