Abstract base class for all back-end command line module implementations.
More...
#include <Libs/CommandLineModules/Core/ctkCmdLineModuleBackend.h>
|
virtual QString | description () const =0 |
| Returns a brief description of the type of the backend. More...
|
|
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. More...
|
|
QByteArray | rawXmlDescription (const QUrl &location) |
| Get the XML parameter description from the given location. More...
|
|
virtual QByteArray | rawXmlDescription (const QUrl &location, int timeout)=0 |
| Get the XML parameter description from the given location. More...
|
|
virtual QList< QString > | schemes () const =0 |
| Returns a list of URL schemes this back-end can handle. More...
|
|
virtual int | timeOutForXmlRetrieval () const |
| returns the number of milliseconds to wait when retrieving xml. More...
|
|
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. More...
|
|
virtual | ~ctkCmdLineModuleBackend () |
|
Abstract base class for all back-end command line module implementations.
A back-end is responsible for providing the XML module description for a given URL and its "timestamp". It also knows how to actually run a module, using the current parameter values provided by a ctkCmdLineModuleFrontend instance.
- See also
- ctkCmdLineModuleBackendLocalProcess
-
ctkCmdLineModuleBackendFunctionPointer
Definition at line 46 of file ctkCmdLineModuleBackend.h.
◆ ~ctkCmdLineModuleBackend()
virtual ctkCmdLineModuleBackend::~ctkCmdLineModuleBackend |
( |
| ) |
|
|
virtual |
◆ description()
virtual QString ctkCmdLineModuleBackend::description |
( |
| ) |
const |
|
pure virtual |
◆ name()
virtual QString ctkCmdLineModuleBackend::name |
( |
| ) |
const |
|
pure virtual |
◆ rawXmlDescription() [1/2]
QByteArray ctkCmdLineModuleBackend::rawXmlDescription |
( |
const QUrl & |
location | ) |
|
Get the XML parameter description from the given location.
- Parameters
-
location | The location URL specifying the module. |
- Returns
- The raw XML parameter description.
This method calls rawXmlDescription(const QUrl&, int) with a timeout of 30 seconds.
- Exceptions
-
◆ rawXmlDescription() [2/2]
virtual QByteArray ctkCmdLineModuleBackend::rawXmlDescription |
( |
const QUrl & |
location, |
|
|
int |
timeout |
|
) |
| |
|
pure virtual |
◆ run()
◆ schemes()
virtual QList<QString> ctkCmdLineModuleBackend::schemes |
( |
| ) |
const |
|
pure virtual |
◆ timeOutForXmlRetrieval()
virtual int ctkCmdLineModuleBackend::timeOutForXmlRetrieval |
( |
| ) |
const |
|
virtual |
returns the number of milliseconds to wait when retrieving xml.
The default implementation returns 0, which signals that the global timeout value from the ctkCmdLineModuleManager object with which this backend was registered should be used.
- Returns
- int Time-out in milliseconds.
◆ timeStamp()
virtual qint64 ctkCmdLineModuleBackend::timeStamp |
( |
const QUrl & |
location | ) |
const |
|
pure virtual |
◆ ctkCmdLineModuleManager
The documentation for this struct was generated from the following file: