![]() |
CTK
0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
|
Provides an ctkCmdLineModuleBackend implementation to run a locally installed command line application. More...
#include <Libs/CommandLineModules/Backend/LocalProcess/ctkCmdLineModuleBackendLocalProcess.h>
Public Member Functions | |
ctkCmdLineModuleBackendLocalProcess () | |
virtual QString | description () const |
Returns a brief description of the type of the backend. More... | |
virtual QString | name () const |
Returns the name of the type of the backend, not the name of the thing or application that is run. More... | |
virtual QByteArray | rawXmlDescription (const QUrl &location, int timeout) |
Get the raw XML description from the module at location . More... | |
virtual ctkCmdLineModuleFuture | run (ctkCmdLineModuleFrontend *frontend) |
Run a front-end for this module in a local process. More... | |
virtual QList< QString > | schemes () const |
This back-end can handle the "file" URL scheme. More... | |
void | setTimeOutForXMLRetrieval (int timeOut) |
Setter for the number of milliseconds to wait when retrieving xml. More... | |
virtual int | timeOutForXMLRetrieval () const |
Returns the number of milliseconds to wait when retrieving xml. More... | |
virtual qint64 | timeStamp (const QUrl &location) const |
Returns the last modified time of the module at location . More... | |
~ctkCmdLineModuleBackendLocalProcess () | |
![]() | |
QByteArray | rawXmlDescription (const QUrl &location) |
Get the XML parameter description from the given location. More... | |
virtual int | timeOutForXmlRetrieval () const |
returns the number of milliseconds to wait when retrieving xml. More... | |
virtual | ~ctkCmdLineModuleBackend () |
Additional Inherited Members |
Provides an ctkCmdLineModuleBackend implementation to run a locally installed command line application.
Use this back-end if you want to be able to register local executables as command line modules. The back-end handles the "file" URL scheme, allowing you to register modules with the ctkCmdLineModuleManager by using
The XML description for a module is extracted from the standard output of the executable when calling it with the ––xml
command line argument.
The ctkCmdLineModuleFuture returned by run() allows cancelation by killing the running process. On Unix systems, it also allows to pause it.
Definition at line 52 of file ctkCmdLineModuleBackendLocalProcess.h.
ctkCmdLineModuleBackendLocalProcess::ctkCmdLineModuleBackendLocalProcess | ( | ) |
ctkCmdLineModuleBackendLocalProcess::~ctkCmdLineModuleBackendLocalProcess | ( | ) |
|
virtual |
Returns a brief description of the type of the backend.
Implements ctkCmdLineModuleBackend.
|
virtual |
Returns the name of the type of the backend, not the name of the thing or application that is run.
Implements ctkCmdLineModuleBackend.
|
virtual |
Get the raw XML description from the module at location
.
location | The location URL of the module for which to get the XML description. |
This method always calls the executable with a ––xml
argument and returns the complete data emitted on the standard output channel.
Implements ctkCmdLineModuleBackend.
|
virtual |
Run a front-end for this module in a local process.
frontend | The front-end to run. |
Implements ctkCmdLineModuleBackend.
|
virtual |
This back-end can handle the "file" URL scheme.
Implements ctkCmdLineModuleBackend.
void ctkCmdLineModuleBackendLocalProcess::setTimeOutForXMLRetrieval | ( | int | timeOut | ) |
Setter for the number of milliseconds to wait when retrieving xml.
timeOut | in milliseconds. |
|
virtual |
Returns the number of milliseconds to wait when retrieving xml.
|
virtual |
Returns the last modified time of the module at location
.
location | The location URL of the module for which to get the timestamp. |
Implements ctkCmdLineModuleBackend.