VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkDynamicLoader Class Reference

class interface to system dynamic libraries More...

#include <vtkDynamicLoader.h>

Inheritance diagram for vtkDynamicLoader:
[legend]
Collaboration diagram for vtkDynamicLoader:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkDynamicLoaderNewInstance () const
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkDynamicLoaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDynamicLoaderSafeDownCast (vtkObjectBase *o)
 
static vtkLibHandle OpenLibrary (const char *)
 Load a dynamic library into the current process. More...
 
static int CloseLibrary (vtkLibHandle)
 Attempt to detach a dynamic library from the process. More...
 
static void * GetSymbolAddress (vtkLibHandle, const char *)
 Find the address of the symbol in the given library static vtkSymbolPointer GetSymbolAddress(vtkLibHandle, const char*);. More...
 
static const char * LibPrefix ()
 Return the library prefix for the given architecture. More...
 
static const char * LibExtension ()
 Return the library extension for the given architecture. More...
 
static const char * LastError ()
 Return the last error produced from a calls made on this class. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDynamicLoader ()
 
 ~vtkDynamicLoader () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

class interface to system dynamic libraries

vtkDynamicLoader provides a portable interface to loading dynamic libraries into a process.

See also
A more portable and lightweight solution is kwsys::DynamicLoader

Definition at line 36 of file vtkDynamicLoader.h.

Member Typedef Documentation

Definition at line 40 of file vtkDynamicLoader.h.

Constructor & Destructor Documentation

vtkDynamicLoader::vtkDynamicLoader ( )
inlineprotected

Definition at line 77 of file vtkDynamicLoader.h.

vtkDynamicLoader::~vtkDynamicLoader ( )
inlineoverrideprotected

Definition at line 78 of file vtkDynamicLoader.h.

Member Function Documentation

static vtkDynamicLoader* vtkDynamicLoader::New ( )
static
static int vtkDynamicLoader::IsTypeOf ( const char *  type)
static
virtual int vtkDynamicLoader::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

static vtkDynamicLoader* vtkDynamicLoader::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkDynamicLoader::NewInstanceInternal ( ) const
protectedvirtual
vtkDynamicLoader* vtkDynamicLoader::NewInstance ( ) const
static vtkLibHandle vtkDynamicLoader::OpenLibrary ( const char *  )
static

Load a dynamic library into the current process.

The returned vtkLibHandle can be used to access the symbols in the library.

static int vtkDynamicLoader::CloseLibrary ( vtkLibHandle  )
static

Attempt to detach a dynamic library from the process.

A value of true is returned if it is successful.

static void* vtkDynamicLoader::GetSymbolAddress ( vtkLibHandle  ,
const char *   
)
static

Find the address of the symbol in the given library static vtkSymbolPointer GetSymbolAddress(vtkLibHandle, const char*);.

static const char* vtkDynamicLoader::LibPrefix ( )
static

Return the library prefix for the given architecture.

static const char* vtkDynamicLoader::LibExtension ( )
static

Return the library extension for the given architecture.

static const char* vtkDynamicLoader::LastError ( )
static

Return the last error produced from a calls made on this class.


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