OpenSceneGraph  3.5.1
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
osgDB::DynamicLibrary Class Reference

DynamicLibrary - encapsulates the loading and unloading of dynamic libraries, typically used for loading ReaderWriter plug-ins. More...

Inheritance diagram for osgDB::DynamicLibrary:
Inheritance graph
[legend]

Public Types

typedef void * HANDLE
 
typedef void * PROC_ADDRESS
 

Public Member Functions

const std::string & getName () const
 return name of library stripped of path. More...
 
const std::string & getFullName () const
 return name of library including full path to it. More...
 
HANDLE getHandle () const
 return handle to .dso/.dll dynamic library itself. More...
 
PROC_ADDRESS getProcAddress (const std::string &procName)
 return address of function located in library. More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Static Public Member Functions

static DynamicLibraryloadLibrary (const std::string &libraryName)
 returns a pointer to a DynamicLibrary object on successfully opening of library returns NULL on failure. More...
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Protected Member Functions

 DynamicLibrary ()
 disallow default constructor. More...
 
 DynamicLibrary (const DynamicLibrary &)
 disallow copy constructor. More...
 
DynamicLibraryoperator= (const DynamicLibrary &)
 disallow copy operator. More...
 
 DynamicLibrary (const std::string &name, HANDLE handle)
 Disallow public construction so that users have to go through loadLibrary() above which returns NULL on failure, a valid DynamicLibrary object on success. More...
 
 ~DynamicLibrary ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Static Protected Member Functions

static HANDLE getLibraryHandle (const std::string &libraryName)
 get handle to library file More...
 

Protected Attributes

HANDLE _handle
 
std::string _name
 
std::string _fullName
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Detailed Description

DynamicLibrary - encapsulates the loading and unloading of dynamic libraries, typically used for loading ReaderWriter plug-ins.

Member Typedef Documentation

Constructor & Destructor Documentation

osgDB::DynamicLibrary::DynamicLibrary ( )
inlineprotected

disallow default constructor.

osgDB::DynamicLibrary::DynamicLibrary ( const DynamicLibrary )
inlineprotected

disallow copy constructor.

osgDB::DynamicLibrary::DynamicLibrary ( const std::string &  name,
HANDLE  handle 
)
protected

Disallow public construction so that users have to go through loadLibrary() above which returns NULL on failure, a valid DynamicLibrary object on success.

osgDB::DynamicLibrary::~DynamicLibrary ( )
protected

Member Function Documentation

const std::string& osgDB::DynamicLibrary::getFullName ( ) const
inline

return name of library including full path to it.

HANDLE osgDB::DynamicLibrary::getHandle ( ) const
inline

return handle to .dso/.dll dynamic library itself.

static HANDLE osgDB::DynamicLibrary::getLibraryHandle ( const std::string &  libraryName)
staticprotected

get handle to library file

const std::string& osgDB::DynamicLibrary::getName ( ) const
inline

return name of library stripped of path.

PROC_ADDRESS osgDB::DynamicLibrary::getProcAddress ( const std::string &  procName)

return address of function located in library.

static DynamicLibrary* osgDB::DynamicLibrary::loadLibrary ( const std::string &  libraryName)
static

returns a pointer to a DynamicLibrary object on successfully opening of library returns NULL on failure.

DynamicLibrary& osgDB::DynamicLibrary::operator= ( const DynamicLibrary )
inlineprotected

disallow copy operator.

Member Data Documentation

std::string osgDB::DynamicLibrary::_fullName
protected
HANDLE osgDB::DynamicLibrary::_handle
protected
std::string osgDB::DynamicLibrary::_name
protected

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

osg logo
Generated at Wed Nov 11 2015 22:14:53 for the OpenSceneGraph by doxygen 1.8.10.