CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
ctkCmdLineModuleBackend.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 CTKCMDLINEMODULEBACKEND_H
23 #define CTKCMDLINEMODULEBACKEND_H
24 
25 #include "ctkCommandLineModulesCoreExport.h"
26 
29 
30 template<typename T> class QList;
31 class QUrl;
32 
46 struct CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleBackend
47 {
48 
50 
56  virtual QString name() const = 0;
57 
62  virtual QString description() const = 0;
63 
68  virtual QList<QString> schemes() const = 0;
69 
75  virtual qint64 timeStamp(const QUrl& location) const = 0;
76 
98  virtual QByteArray rawXmlDescription(const QUrl& location, int timeout) = 0;
99 
113  QByteArray rawXmlDescription(const QUrl& location);
114 
124  virtual int timeOutForXmlRetrieval() const;
125 
126 protected:
127 
129 
139 
140 };
141 
142 #endif // CTKCMDLINEMODULEBACKEND_H
Abstract base class for all front-end command line module implementations.
QFuture sub-class for enhanced communication with running modules.
Main manager class to handle loading and unloading of modules.
Abstract base class for all back-end command line module implementations.
virtual ctkCmdLineModuleFuture run(ctkCmdLineModuleFrontend *frontend)=0
The main method to actually execute the back-end process.
virtual QByteArray rawXmlDescription(const QUrl &location, int timeout)=0
Get the XML parameter description from the given location.
QByteArray rawXmlDescription(const QUrl &location)
Get the XML parameter description from the given location.
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 ...
virtual ~ctkCmdLineModuleBackend()
virtual int timeOutForXmlRetrieval() const
returns the number of milliseconds to wait when retrieving xml.
virtual QList< QString > schemes() const =0
Returns a list of URL schemes this back-end can handle.
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.
virtual QString description() const =0
Returns a brief description of the type of the backend.