CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
ctkCmdLineModuleBackendLocalProcess.h
Go to the documentation of this file.
1 /*=============================================================================
2 
3  Library: CTK
4 
5  Copyright (c) German Cancer Research Center,
6  Division of Medical and Biological Informatics
7 
8  Licensed under the Apache License, Version 2.0 (the "License");
9  you may not use this file except in compliance with the License.
10  You may obtain a copy of the License at
11 
12  http://www.apache.org/licenses/LICENSE-2.0
13 
14  Unless required by applicable law or agreed to in writing, software
15  distributed under the License is distributed on an "AS IS" BASIS,
16  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  See the License for the specific language governing permissions and
18  limitations under the License.
19 
20 =============================================================================*/
21 
22 #ifndef CTKCMDLINEMODULEBACKENDLOCALPROCESS_H
23 #define CTKCMDLINEMODULEBACKENDLOCALPROCESS_H
24 
26 
27 #include "ctkCommandLineModulesBackendLocalProcessExport.h"
28 
29 #include <QScopedPointer>
30 
31 struct ctkCmdLineModuleBackendLocalProcessPrivate;
32 
52 class CTK_CMDLINEMODULEBACKENDLP_EXPORT ctkCmdLineModuleBackendLocalProcess : public ctkCmdLineModuleBackend
53 {
54 
55 public:
56 
59 
60  virtual QString name() const;
61  virtual QString description() const;
62 
67  virtual QList<QString> schemes() const;
68 
74  virtual qint64 timeStamp(const QUrl &location) const;
75 
84  virtual QByteArray rawXmlDescription(const QUrl& location, int timeout);
85 
92 
97  void setTimeOutForXMLRetrieval(int timeOut);
98 
103  virtual int timeOutForXMLRetrieval() const;
104 
105 private:
106 
107  QScopedPointer<ctkCmdLineModuleBackendLocalProcessPrivate> d;
108 
109 };
110 
111 #endif // CTKCMDLINEMODULEBACKENDLOCALPROCESS_H
Provides an ctkCmdLineModuleBackend implementation to run a locally installed command line applicatio...
void setTimeOutForXMLRetrieval(int timeOut)
Setter for the number of milliseconds to wait when retrieving xml.
virtual ctkCmdLineModuleFuture run(ctkCmdLineModuleFrontend *frontend)
Run a front-end for this module in a local process.
virtual qint64 timeStamp(const QUrl &location) const
Returns the last modified time of the module at location.
virtual QByteArray rawXmlDescription(const QUrl &location, int timeout)
Get the raw XML description from the module at location.
virtual QList< QString > schemes() const
This back-end can handle the "file" URL scheme.
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 int timeOutForXMLRetrieval() const
Returns the number of milliseconds to wait when retrieving xml.
virtual QString description() const
Returns a brief description of the type of the backend.
Abstract base class for all front-end command line module implementations.
QFuture sub-class for enhanced communication with running modules.
Abstract base class for all back-end command line module implementations.