Computer Assited Medical Intervention Tool Kit  version 4.1
ComponentExtension.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2018 Univ. Grenoble Alpes, CNRS, TIMC-IMAG UMR 5525 (GMCAO)
6  *
7  * Visit http://camitk.imag.fr for more information
8  *
9  * This file is part of CamiTK.
10  *
11  * CamiTK is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * CamiTK is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License version 3 for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
22  *
23  * $CAMITK_LICENCE_END$
24  ****************************************************************************/
25 
26 
27 #ifndef COMPONENT_EXTENSION_H
28 #define COMPONENT_EXTENSION_H
29 
30 // -- CamiTK Core stuff
31 #include "CamiTKAPI.h"
32 #include "AbortException.h"
33 #include "Component.h"
34 
35 namespace camitk {
57 class CAMITK_API ComponentExtension : public QObject {
58 
59 protected:
60 
63 
64 public:
65 
67  ~ComponentExtension() override = default;
68 
72  virtual QString getName() const = 0;
73 
75  virtual QString getDescription() const = 0;
76 
78  virtual QStringList getFileExtensions() const = 0;
79 
89  virtual Component* open(const QString&) = 0;
90 
109  virtual bool save(Component* component) const;
110 
112  virtual bool hasDataDirectory() const {
113  return false;
114  }
115 
117  QString getLocation() const {
118  return dynamicLibraryFileName;
119  }
120 
122  void setLocation(const QString loc) {
123  dynamicLibraryFileName = loc;
124  }
125 
127  void initResources();
128 
130 
131 
132 private:
135 
137  bool autoload;
138 };
139 
140 
141 
142 }
143 // -------------------- declare the interface for QPluginLoader --------------------
144 Q_DECLARE_INTERFACE(camitk::ComponentExtension, "TIMC-IMAG.ComponentExtension/2.1") //TODO use variable from CMake?
145 
146 
147 #endif //COMPONENT_EXTENSION_H
void setLocation(const QString loc)
set the file path (once loaded as a dynamic library)
Definition: ComponentExtension.h:122
bool autoload
the autoload state
Definition: ComponentExtension.h:137
Definition: Action.cpp:36
This class describes what is a generic Component extension.
Definition: ComponentExtension.h:57
A Component represents something that could be included in the explorer view, the interactive 3D view...
Definition: sdk/libraries/core/component/Component.h:298
#define CAMITK_API
Definition: CamiTKAPI.h:49
QString dynamicLibraryFileName
the shared lib (.so, .dll or .dylib) used to instanciate the ComponentExtension subclass instance ...
Definition: ComponentExtension.h:134
QString getLocation() const
get the file path (location of the .dll/.so/.dylib) of this plugin
Definition: ComponentExtension.h:117
virtual bool hasDataDirectory() const
return true if this component manages directory instead of individual files (e.g. Dicom series are st...
Definition: ComponentExtension.h:112