CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
ctkCmdLineModuleReference.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 CTKCMDLINEMODULEREFERENCE_H
23 #define CTKCMDLINEMODULEREFERENCE_H
24 
25 #include <ctkCommandLineModulesCoreExport.h>
26 
27 #include <QSharedDataPointer>
28 #include <QMetaType>
29 
32 struct ctkCmdLineModuleReferencePrivate;
33 
44 class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleReference
45 {
46 public:
47 
53 
56 
60  operator bool() const;
61 
67  ctkCmdLineModuleDescription description() const;
68 
73  QByteArray rawXmlDescription() const;
74 
80  QString xmlValidationErrorString() const;
81 
86  QUrl location() const;
87 
92  ctkCmdLineModuleBackend* backend() const;
93 
94 private:
95 
97  friend uint CTK_CMDLINEMODULECORE_EXPORT qHash(const ctkCmdLineModuleReference&);
98 
99  QSharedDataPointer<ctkCmdLineModuleReferencePrivate> d;
100 
101 };
102 
104 
105 uint CTK_CMDLINEMODULECORE_EXPORT qHash(const ctkCmdLineModuleReference& moduleRef);
106 
107 #endif // CTKCMDLINEMODULEREFERENCE_H
ctkCmdLineModuleManager
Main manager class to handle loading and unloading of modules.
Definition: ctkCmdLineModuleManager.h:71
ctkCmdLineModuleDescription
Description of the parameters of a command line module.
Definition: ctkCmdLineModuleDescription.h:46
ctkCmdLineModuleBackend
Abstract base class for all back-end command line module implementations.
Definition: ctkCmdLineModuleBackend.h:46
ctkCmdLineModuleReference
Defines a reference or handle to a module, including location, XML, description and access to the ass...
Definition: ctkCmdLineModuleReference.h:44
Q_DECLARE_METATYPE
Q_DECLARE_METATYPE(ctkDICOMPersonName)
qHash
uint CTK_CMDLINEMODULECORE_EXPORT qHash(const ctkCmdLineModuleReference &moduleRef)