Plugin Class Reference

#include <Plugin.h>

Inheritance diagram for Plugin:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 Plugin (const string name)
virtual ~Plugin ()
virtual void load (const string) throw (FileNotFound, LibHandleError)
virtual void unload () throw (LibHandleError)
virtual void run ()
virtual void registerParameter ()
virtual void registerOutputFields ()
virtual void requestPlugins ()
virtual void init ()
virtual void release ()
virtual void selftest ()
string getName ()
string getVersion ()
string getAuthors ()
string getDescription ()
string getCategory ()
PluginCategory getCategoryID ()
bool isLoaded ()
void setCategory (string new_type)
run_function getRunFunction ()

Protected Attributes

void * LibHandle
const string name
string path
string category
bool is_released
bool is_initialized
bool is_registered
bool is_loaded

Private Member Functions

 Plugin (const Plugin &x)
 hidden copy constructor - we do not want to accidentially copy objects
void_t get_dl_voidFunc (string) throw (LibHandleError)
char_t get_dl_stringFunc (string) throw (LibHandleError)
category_t get_categoryFunc (string) throw (LibHandleError)

Private Attributes

void_t func_void
char_t func_get_string
char_t func_get_name
char_t func_get_version
char_t func_get_authors
char_t func_get_description
category_t func_get_category
void_t func_run
void_t func_register_parameter
void_t func_register_output_fields
void_t func_request_plugins
void_t func_init
void_t func_release
int rc

Constructor & Destructor Documentation

Plugin::Plugin ( const Plugin x  )  [private]

hidden copy constructor - we do not want to accidentially copy objects

Plugin::Plugin ( const string  name  ) 

Plugin::~Plugin (  )  [virtual]


Member Function Documentation

void_t Plugin::get_dl_voidFunc ( string   )  throw (LibHandleError) [private]

char_t Plugin::get_dl_stringFunc ( string   )  throw (LibHandleError) [private]

category_t Plugin::get_categoryFunc ( string   )  throw (LibHandleError) [private]

void Plugin::load ( const   string  )  throw (FileNotFound, LibHandleError) [virtual]

Reimplemented in CrustalDecayPlugin, DataOutPlugin, GreenPlugin, LoadHistoryPlugin, and LoadPlugin.

void Plugin::unload (  )  throw (LibHandleError) [virtual]

Reimplemented in GreensFunction, and LoadFunction.

void Plugin::run (  )  [virtual]

void Plugin::registerParameter (  )  [virtual]

Reimplemented in GreensFunction, and LoadFunction.

void Plugin::registerOutputFields (  )  [virtual]

Reimplemented in GreensFunction, and LoadFunction.

void Plugin::requestPlugins (  )  [virtual]

Reimplemented in GreensFunction, and LoadFunction.

void Plugin::init (  )  [virtual]

Reimplemented in GreensFunction, and LoadFunction.

void Plugin::release (  )  [virtual]

Reimplemented in GreensFunction, and LoadFunction.

void Plugin::selftest (  )  [virtual]

string Plugin::getName (  ) 

string Plugin::getVersion (  ) 

string Plugin::getAuthors (  ) 

string Plugin::getDescription (  ) 

string Plugin::getCategory (  ) 

PluginCategory Plugin::getCategoryID (  ) 

bool Plugin::isLoaded (  ) 

tells whether Plugin::load() was called and succeeded

void Plugin::setCategory ( string  new_type  ) 

run_function Plugin::getRunFunction (  ) 


Member Data Documentation

void_t Plugin::func_void [private]

char_t Plugin::func_get_string [private]

char_t Plugin::func_get_name [private]

char_t Plugin::func_get_version [private]

char_t Plugin::func_get_authors [private]

char_t Plugin::func_get_description [private]

category_t Plugin::func_get_category [private]

void_t Plugin::func_run [private]

void_t Plugin::func_register_parameter [private]

void_t Plugin::func_register_output_fields [private]

void_t Plugin::func_request_plugins [private]

void_t Plugin::func_init [private]

void_t Plugin::func_release [private]

int Plugin::rc [private]

void* Plugin::LibHandle [protected]

const string Plugin::name [protected]

string Plugin::path [protected]

string Plugin::category [protected]

bool Plugin::is_released [protected]

bool Plugin::is_initialized [protected]

bool Plugin::is_registered [protected]

bool Plugin::is_loaded [protected]


The documentation for this class was generated from the following files:
Generated on Sun Aug 31 13:20:42 2008 for CrusDe by  doxygen 1.5.0