Provides a back-end implementation to enable directly calling a function pointer.
More...
|
| ctkCmdLineModuleBackendFunctionPointer () |
|
virtual QString | description () const |
| Returns a brief description of the type of the backend.
|
|
virtual QString | name () const |
| Returns the name of the type of the backend, not the name of the thing or application that is run.
|
|
virtual QByteArray | rawXmlDescription (const QUrl &location, int timeout) |
| Get the XML parameter description from the given location.
|
|
QList< QUrl > | registeredFunctionPointers () const |
|
template<typename A > |
Description * | registerFunctionPointer (const QString &title, void(*fp)(A), const QString ¶mLabel=QString(), const QString ¶mDescr=QString()) |
|
template<typename A , typename B > |
Description * | registerFunctionPointer (const QString &title, void(*fp)(A, B), const QString ¶mLabel0=QString(), const QString ¶mDescr0=QString(), const QString ¶mLabel1=QString(), const QString ¶mDescr1=QString()) |
|
virtual QList< QString > | schemes () const |
| Returns a list of URL schemes this back-end can handle.
|
|
virtual qint64 | timeStamp (const QUrl &location) const |
| Returns a timestap of the backend, which for example in the case of the LocalProcess may be the last modified time of the command line application.
|
|
| ~ctkCmdLineModuleBackendFunctionPointer () |
|
virtual QString | description () const =0 |
| Returns a brief description of the type of the backend.
|
|
virtual QString | name () const =0 |
| Returns the name of the type of the backend, not the name of the thing or application that is run.
|
|
QByteArray | rawXmlDescription (const QUrl &location) |
| Get the XML parameter description from the given location.
|
|
virtual QByteArray | rawXmlDescription (const QUrl &location, int timeout)=0 |
| Get the XML parameter description from the given location.
|
|
virtual QList< QString > | schemes () const =0 |
| Returns a list of URL schemes this back-end can handle.
|
|
virtual int | timeOutForXmlRetrieval () const |
| returns the number of milliseconds to wait when retrieving xml.
|
|
virtual qint64 | timeStamp (const QUrl &location) const =0 |
| Returns a timestap of the backend, which for example in the case of the LocalProcess may be the last modified time of the command line application.
|
|
virtual | ~ctkCmdLineModuleBackend () |
|
Provides a back-end implementation to enable directly calling a function pointer.
- Warning
- This back-end is highly experimental and will not work for most function pointers when trying to register them via registerFunctionPointer().
Definition at line 102 of file ctkCmdLineModuleBackendFunctionPointer.h.
virtual QByteArray ctkCmdLineModuleBackendFunctionPointer::rawXmlDescription |
( |
const QUrl & |
location, |
|
|
int |
timeout |
|
) |
| |
|
virtual |
Get the XML parameter description from the given location.
- Parameters
-
location | The location URL specifying the module. |
timeout | The time-out for retrieving the XML parameter description |
- Returns
- The raw XML parameter description.
This method may be concurrently called by the ctkCmdLineModuleManager and must be thread-safe. Implementations must not use any caching mechanism, as caching is done by the ctkCmdLineModuleManager itself, checking the return value of timeStamp().
Implementations should also throw either a ctkCmdLineModuleTimeoutException object if a time-out occured when retrieving the XML parameter description or a ctkCmdLineModuleRunException for any other error during invocation of the module.
- Exceptions
-
Implements ctkCmdLineModuleBackend.