#include <FFaUserFuncPlugin.H>
Inheritance diagram for FFaUserFuncPlugin:
Collaboration diagram for FFaUserFuncPlugin:
Public Member Functions | |
| bool | validate (const std::string &libName, int nchar=0, char *sign=NULL) |
| bool | getSign (int nchar, char *sign) const |
| int | getFuncs (int maxUF, int *funcId, bool silence=false) const |
| int | getFuncName (int id, int nchar=0, char *name=NULL) const |
| int | getParName (int id, int ipar=1, int nchar=0, char *name=NULL) const |
| double | getDefaultParVal (int id, int ipar) const |
| const char ** | getPixmap (int id) const |
| int | getFlag (int id) const |
| double | getValue (int bId, int fId, const double *params, double x, int &ierr) const |
| double | getValue (int bId, int fId, const double *params, const double *args, int &err) const |
| double | getDiff (int bId, int fId, int ia, const double *params, const double *args, int &err) const |
| int | wave (int bId, int fId, double d, double g, const double *params, const double *args, double &h, double *u, double *du) const |
 Public Member Functions inherited from FFaDynamicLibraryBase | |
| bool | load (const std::string &libName, bool silence=false) |
| Loads the library named libName. More... | |
| bool | unload (const std::string &libName, bool silence=false) |
| Unloads the library named libName. More... | |
| void | unloadAll () |
| Unloads all libraries and clears the function cache. More... | |
| bool | areLibsLoaded () const |
| Returns whether dynamics libraries have been loaded or not. More... | |
| const char * | getLibrary (size_t idx=1) const |
| Returns the file name of the dynamic library, if loaded. More... | |
Protected Member Functions | |
| FFaUserFuncPlugin () | |
| virtual | ~FFaUserFuncPlugin () |
| Protected Member Functions inherited from FFaDynamicLibraryBase | |
| FFaDynamicLibraryBase () | |
| Default constructor. More... | |
| virtual | ~FFaDynamicLibraryBase () |
| The destructor unloads all dynamically loaded libraries. More... | |
| DLPROC | getProcAddr (const std::string &fName, bool silence=false) const |
| Returns the function pointer for the named function. More... | |
| DLPROC | getProcAddr (const std::string &cName, const std::string &fName, LanguageBinding &lang, bool silence=false) const |
| Returns the function pointer for the named function. More... | |
| DLPROC | getProcAddress (const std::string &fName, size_t procID) const |
| Returns the function pointer for the given function. More... | |
| DLPROC | getProcAddress (const std::string &cName, const std::string &fName, LanguageBinding &lang, size_t procID) const |
| Returns the function pointer for the given function. More... | |
| Protected Member Functions inherited from FFaSingelton< FFaUserFuncPlugin > | |
| FFaSingelton () | |
| The constructor is protected to allow objects of sub-classes only. More... | |
| FFaSingelton (const FFaSingelton &)=delete | |
| Disable default copy constructor. More... | |
| FFaSingelton & | operator= (const FFaSingelton &)=delete |
| Disable default assignment operator. More... | |
Friends | |
| class | FFaSingelton< FFaUserFuncPlugin > |
Additional Inherited Members | |
| Static Public Member Functions inherited from FFaSingelton< FFaUserFuncPlugin > | |
| static FFaUserFuncPlugin * | instance () |
| Returns the actual instance of this class. More... | |
| static void | removeInstance () |
| Deletes the dynamically allocated instance. More... | |
| static bool | allocated () |
| Returns true, if the instance has been allocated. More... | |
| Protected Types inherited from FFaDynamicLibraryBase | |
| enum | LanguageBinding { Undefined , C , Fortran } |
| Enums defining the supported language bindings. More... | |
Constructor & Destructor Documentation
◆ FFaUserFuncPlugin()
|
inlineprotected |
◆ ~FFaUserFuncPlugin()
|
inlineprotectedvirtual |
Member Function Documentation
◆ getDefaultParVal()
| double FFaUserFuncPlugin::getDefaultParVal | ( | int | id, |
| int | ipar | ||
| ) | const |
◆ getDiff()
| double FFaUserFuncPlugin::getDiff | ( | int | bId, |
| int | fId, | ||
| int | ia, | ||
| const double * | params, | ||
| const double * | args, | ||
| int & | err | ||
| ) | const |
◆ getFlag()
| int FFaUserFuncPlugin::getFlag | ( | int | id | ) | const |
◆ getFuncName()
| int FFaUserFuncPlugin::getFuncName | ( | int | id, |
| int | nchar = 0, |
||
| char * | name = NULL |
||
| ) | const |
◆ getFuncs()
| int FFaUserFuncPlugin::getFuncs | ( | int | maxUF, |
| int * | funcId, | ||
| bool | silence = false |
||
| ) | const |
◆ getParName()
| int FFaUserFuncPlugin::getParName | ( | int | id, |
| int | ipar = 1, |
||
| int | nchar = 0, |
||
| char * | name = NULL |
||
| ) | const |
◆ getPixmap()
| const char ** FFaUserFuncPlugin::getPixmap | ( | int | id | ) | const |
◆ getSign()
| bool FFaUserFuncPlugin::getSign | ( | int | nchar, |
| char * | sign | ||
| ) | const |
◆ getValue() [1/2]
| double FFaUserFuncPlugin::getValue | ( | int | bId, |
| int | fId, | ||
| const double * | params, | ||
| const double * | args, | ||
| int & | err | ||
| ) | const |
◆ getValue() [2/2]
| double FFaUserFuncPlugin::getValue | ( | int | bId, |
| int | fId, | ||
| const double * | params, | ||
| double | x, | ||
| int & | ierr | ||
| ) | const |
◆ validate()
| bool FFaUserFuncPlugin::validate | ( | const std::string & | libName, |
| int | nchar = 0, |
||
| char * | sign = NULL |
||
| ) |
◆ wave()
| int FFaUserFuncPlugin::wave | ( | int | bId, |
| int | fId, | ||
| double | d, | ||
| double | g, | ||
| const double * | params, | ||
| const double * | args, | ||
| double & | h, | ||
| double * | u, | ||
| double * | du | ||
| ) | const |
Friends And Related Function Documentation
◆ FFaSingelton< FFaUserFuncPlugin >
|
friend |
The documentation for this class was generated from the following files:
- fedem-foundation/src/FFaFunctionLib/FFaUserFuncPlugin.H
- fedem-foundation/src/FFaFunctionLib/FFaUserFuncPlugin.C
