Computer Assited Medical Intervention Tool Kit  version 5.0
ExtensionGenerator.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2021 Univ. Grenoble Alpes, CNRS, Grenoble INP, TIMC, 38000 Grenoble, France
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 #ifndef EXTENSIONGENERATOR_H
26 #define EXTENSIONGENERATOR_H
27 
28 #if defined(_WIN32) && !defined(__MINGW32__) // MSVC only
29 #pragma warning( disable : 4290 )
30 #endif // MSVC only
31 
32 
33 // includes from Qt
34 #include <QString>
35 #include <QVector>
36 
37 
50 
51 public:
52  ExtensionGenerator(QString actionExtensionsDirectory, QString licence = "", QString extensionType = "NONE");
53 
54  virtual ~ExtensionGenerator();
55 
56  virtual void generateExtension();
57 
58 protected:
60 
62  virtual void generateExtensionCMakeLists(QString directory);
63 
65  virtual void generateExtensionClass(QString directory) = 0;
66 
67  virtual void writeCFile(QString directory) = 0;
68  virtual void writeHFile(QString directory) = 0;
69 
70  virtual void generateTestDataFiles(QString directory, QString testDataDirName) = 0;
71 
73 
74 
77 
79  QString extensionType;
80 
82  QString name;
83 
84  QString description;
85 
86  QString licence;
87 
88  QVector<DependencyGenerator* > dependencyGenerators;
89 };
90 
91 #endif
ExtensionGenerator::extensionsDirectory
QString extensionsDirectory
Absolute path to the extensions directory.
Definition: ExtensionGenerator.h:76
DependencyGenerator::getExternalLibsString
static QString getExternalLibsString(QVector< DependencyGenerator * > dependencies)
Definition: DependencyGenerator.cpp:71
ExtensionGenerator::ExtensionGenerator
ExtensionGenerator(QString actionExtensionsDirectory, QString licence="", QString extensionType="NONE")
Definition: ExtensionGenerator.cpp:46
ExtensionGenerator::name
QString name
Name of the extension.
Definition: ExtensionGenerator.h:82
DependencyGenerator.h
DependencyGenerator::getCepLibsString
static QString getCepLibsString(QVector< DependencyGenerator * > dependencies)
Definition: DependencyGenerator.cpp:88
testDataDirName
static const QString testDataDirName
Definition: ExtensionGenerator.cpp:44
ExtensionGenerator::extensionType
QString extensionType
Extension type: Action or Component extension.
Definition: ExtensionGenerator.h:79
ExtensionGenerator::writeHFile
virtual void writeHFile(QString directory)=0
ExtensionGenerator::setExtensionsDirectory
void setExtensionsDirectory(QString extensionsDirectory)
Definition: ExtensionGenerator.cpp:55
ExtensionGenerator
Common abstract class to generate extensions.
Definition: ExtensionGenerator.h:49
DependencyGenerator::getNeededComponentsString
static QString getNeededComponentsString(QVector< DependencyGenerator * > dependencies)
Definition: DependencyGenerator.cpp:105
ExtensionGenerator::generateExtensionCMakeLists
virtual void generateExtensionCMakeLists(QString directory)
Helpers methods.
Definition: ExtensionGenerator.cpp:90
ExtensionGenerator::generateExtension
virtual void generateExtension()
Definition: ExtensionGenerator.cpp:59
ExtensionGenerator::~ExtensionGenerator
virtual ~ExtensionGenerator()
Definition: ExtensionGenerator.cpp:52
description
const char * description
Definition: applications/cepgenerator/main.cpp:38
ExtensionGenerator::generateExtensionClass
virtual void generateExtensionClass(QString directory)=0
generate an action, a component of a viewer
DependencyGenerator::getNeededViewersString
static QString getNeededViewersString(QVector< DependencyGenerator * > dependencies)
Definition: DependencyGenerator.cpp:140
ExtensionGenerator::writeCFile
virtual void writeCFile(QString directory)=0
ExtensionGenerator::licence
QString licence
Definition: ExtensionGenerator.h:86
DependencyGenerator
Create the dependencies, generate the "NEEDs_LIBRARY" in the cmake file.
Definition: DependencyGenerator.h:48
ExtensionGenerator::description
QString description
Definition: ExtensionGenerator.h:84
ExtensionGenerator::generateTestDataFiles
virtual void generateTestDataFiles(QString directory, QString testDataDirName)=0
ExtensionGenerator.h
cepcoreschema
Definition: ActionExtensionGenerator.h:36
DependencyGenerator::getNeededActionsString
static QString getNeededActionsString(QVector< DependencyGenerator * > dependencies)
Definition: DependencyGenerator.cpp:122
ExtensionGenerator::dependencyGenerators
QVector< DependencyGenerator * > dependencyGenerators
Definition: ExtensionGenerator.h:88