frepple::utils::CommandLoadLibrary Class Reference
Command to dynamically load a shared library in frePPLe. More...
#include <utils.h>
Inheritance diagram for frepple::utils::CommandLoadLibrary:

Public Types | |
typedef map< string, XMLElement > | ParameterList |
Public Member Functions | |
void | addParameter (const string &name, const string &value) |
CommandLoadLibrary () | |
CommandLoadLibrary (const string &libname) | |
void | endElement (XMLInput &pIn, const Attribute &pAttr, const DataElement &pElement) |
void | execute () |
string | getLibraryName () |
void | setLibraryName (const string &libname) |
Static Public Member Functions | |
static PyObject * | executePython (PyObject *, PyObject *, PyObject *) |
static bool | isLoaded (const string &s) |
static void | printModules () |
Detailed Description
Command to dynamically load a shared library in frePPLe.
After loading the library, the function "initialize" of the module is executed.
The current implementation of the command works on the following platforms:
- Windows
- Linux
- Unix systems supporting the dlopen function in the standard way. Some unix systems have other or deviating APIs. A pretty messy story :-<
Definition at line 4001 of file utils.h.
Member Typedef Documentation
typedef map<string,XMLElement> frepple::utils::CommandLoadLibrary::ParameterList |
Constructor & Destructor Documentation
frepple::utils::CommandLoadLibrary::CommandLoadLibrary | ( | const string & | libname | ) | [inline, explicit] |
frepple::utils::CommandLoadLibrary::CommandLoadLibrary | ( | ) | [inline, explicit] |
Member Function Documentation
void frepple::utils::CommandLoadLibrary::addParameter | ( | const string & | name, | |
const string & | value | |||
) | [inline] |
void frepple::utils::CommandLoadLibrary::endElement | ( | XMLInput & | pIn, | |
const Attribute & | pAttr, | |||
const DataElement & | pElement | |||
) |
void frepple::utils::CommandLoadLibrary::execute | ( | ) | [virtual] |
Load the library, and execute the initialize() method.
- Exceptions:
-
RuntimeException When the library can't be loaded or when the initialize() method doesn't exist in the library.
Implements frepple::utils::Command.
Definition at line 388 of file utils/actions.cpp.
PyObject * frepple::utils::CommandLoadLibrary::executePython | ( | PyObject * | self, | |
PyObject * | args, | |||
PyObject * | kwds | |||
) | [static] |
Python equivalent of this command.
Definition at line 483 of file utils/actions.cpp.
string frepple::utils::CommandLoadLibrary::getLibraryName | ( | ) | [inline] |
static bool frepple::utils::CommandLoadLibrary::isLoaded | ( | const string & | s | ) | [inline, static] |
void frepple::utils::CommandLoadLibrary::printModules | ( | ) | [static] |
Print all modules that have been loaded.
Definition at line 523 of file utils/actions.cpp.
void frepple::utils::CommandLoadLibrary::setLibraryName | ( | const string & | libname | ) | [inline] |
The documentation for this class was generated from the following files:
Documentation generated for frePPLe by
