sos_capi_common.h File Reference
Last update: 10.02.2025C-API for utility functions (load/unload library, license management, error handling) More...
Go to the source code of this file.
Enumerations | |
Public type definitions | |
Pubic type definitions used within this API | |
| enum | fmop_error_t { fmop_success = 0, fmop_invalid_handle = 1, fmop_exception_occurred = 2, fmop_settings_error = 3, fmop_model_missing = 4, fmop_license_error = 5, fmop_script_error = 6, fmop_script_no_object = 7, fmop_script_wrong_type = 8, fmop_not_implemented = 16382, fmop_const_max = 16383 } |
| Error code definitions. More... | |
| enum | fmop_license_t { fmop_mesh_signal = 10, fmop_mesh_all = 30 } |
| FMOP mesh features which need to be unlocked by a valid license. More... | |
| enum | fmop_dataobject_types { fmop_node_data = 0, fmop_element_data = 1, fmop_scalar_data = 3 } |
| Data type definitions. More... | |
Functions | |
License handling | |
API handling licenes requests | |
| DYNARDO_FMOP_API fmop_error_t | FMOP_appendLicenseSearchPath (const char *abs_path) |
| Appends another license search path to the default ones. More... | |
| DYNARDO_FMOP_API fmop_error_t | FMOP_acquireLicense () |
| Acquires an optiSLang enterprise license. More... | |
| DYNARDO_FMOP_API bool | FMOP_licenseLocked () |
| Check whether any license feature was acquired. More... | |
| DYNARDO_FMOP_API fmop_error_t | FMOP_releaseLicense () |
| Release the acquired license. More... | |
Error Handling | |
API to access and interpret recent data object error messages | |
| DYNARDO_FMOP_API const char * | FMOP_getLastErrorString () |
| Returns internal log messages of level warning and above. More... | |
| DYNARDO_FMOP_API fmop_error_t | FMOP_getLastErrno () |
| Returns the error number which has been set at the last library call. More... | |
| DYNARDO_FMOP_API const char * | FMOP_getLastErrnoString () |
| Returns a pointer to a string that describes the error code which has been set at the last library call. More... | |
| DYNARDO_FMOP_API const char * | FMOP_getLastLogString () |
| Returns internal log messages of log levels defined by FMOP_setLogLevel. Serves as debug logger. More... | |
| DYNARDO_FMOP_API int | FMOP_setLogLevel (int log_level) |
| Defines the new log level filter. Valid for all subsequent library calls until a new log level gets set. More... | |
| DYNARDO_FMOP_API const char * | FMOP_getErrnoString (fmop_error_t error_num) |
| Returns a string description for the error number given. More... | |
Miscellaneous | |
| DYNARDO_FMOP_API const char * | FMOP_getVersionString () |
| Returns a version string. More... | |
FMOP library handling | |
| DYNARDO_FMOP_API fmop_error_t | FMOP_initializeLibrary () |
| Initialize the FMOP library Allocates memory for the global script engine. Call FMOP_unloadLibrary() to release it. A warning is logged if the library was initialized already. More... | |
| DYNARDO_FMOP_API fmop_error_t | FMOP_unloadLibrary () |
| Unload the FMOP library Clears the FMOP library from memory. A warning is logged if the library was unloaded already. | |
Detailed Description
C-API for utility functions (load/unload library, license management, error handling)
- Copyright
- DYNARDO Austria GmbH
