Computer Assited Medical Intervention Tool Kit  version 4.1
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-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 #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 
49 class ExtensionGenerator {
50 
51 public:
52  ExtensionGenerator(QString actionExtensionsDirectory, QString licence = "", QString extensionType = "NONE");
53 
55 
56  virtual void generateExtension();
57 
58 protected:
59  virtual void setExtensionsDirectory(QString extensionsDirectory) ;
60 
62  virtual void generateExtensionCMakeLists(QString directory);
63 
64  virtual void generateActionOrComponent(QString directory) = 0;
65 
66  virtual void writeCFile(QString directory) = 0;
67  virtual void writeHFile(QString directory) = 0;
68 
69  virtual void generateTestDataFiles(QString directory, QString testDataDirName) = 0;
70 
72 
73 
75  QString extensionsDirectory;
76 
78  QString extensionType;
79 
81  QString name;
82 
83  QString description;
84 
85  QString licence;
86 
87  QVector<DependencyGenerator* > dependencyGenerators;
88 };
89 
90 #endif
ExtensionGenerator::extensionsDirectory
QString extensionsDirectory
Absolute path to the extensions directory.
Definition: ExtensionGenerator.h:74
DependencyGenerator::getExternalLibsString
static QString getExternalLibsString(QVector< DependencyGenerator * > dependencies)
Definition: DependencyGenerator.cpp:66
ExtensionGenerator::ExtensionGenerator
ExtensionGenerator(QString actionExtensionsDirectory, QString licence="", QString extensionType="NONE")
Definition: ExtensionGenerator.cpp:45
ExtensionGenerator::name
QString name
Name of the extension.
Definition: ExtensionGenerator.h:80
DependencyGenerator.h
DependencyGenerator::getCepLibsString
static QString getCepLibsString(QVector< DependencyGenerator * > dependencies)
Definition: DependencyGenerator.cpp:83
testDataDirName
static const QString testDataDirName
Definition: ExtensionGenerator.cpp:43
ExtensionGenerator::extensionType
QString extensionType
Extension type: Action or Component extension.
Definition: ExtensionGenerator.h:77
ExtensionGenerator::writeHFile
virtual void writeHFile(QString directory)=0
ExtensionGenerator::setExtensionsDirectory
virtual void setExtensionsDirectory(QString extensionsDirectory)
Definition: ExtensionGenerator.cpp:57
ExtensionGenerator
Common abstract class to generate extensions.
Definition: ExtensionGenerator.h:48
DependencyGenerator::getNeededComponentsString
static QString getNeededComponentsString(QVector< DependencyGenerator * > dependencies)
Definition: DependencyGenerator.cpp:100
ExtensionGenerator::generateExtensionCMakeLists
virtual void generateExtensionCMakeLists(QString directory)
Helpers methods.
Definition: ExtensionGenerator.cpp:92
ExtensionGenerator::generateActionOrComponent
virtual void generateActionOrComponent(QString directory)=0
ExtensionGenerator::generateExtension
virtual void generateExtension()
Definition: ExtensionGenerator.cpp:61
ExtensionGenerator::~ExtensionGenerator
~ExtensionGenerator()
Definition: ExtensionGenerator.cpp:51
description
const char * description
Definition: applications/cepgenerator/main.cpp:37
ExtensionGenerator::writeCFile
virtual void writeCFile(QString directory)=0
ExtensionGenerator::licence
QString licence
Definition: ExtensionGenerator.h:84
DependencyGenerator
Create the dependencies, generate the "NEEDs_LIBRARY" in the cmake file.
Definition: DependencyGenerator.h:47
ExtensionGenerator::description
QString description
Definition: ExtensionGenerator.h:82
ExtensionGenerator::generateTestDataFiles
virtual void generateTestDataFiles(QString directory, QString testDataDirName)=0
ExtensionGenerator.h
cepcoreschema
Definition: ActionExtensionGenerator.h:35
DependencyGenerator::getNeededActionsString
static QString getNeededActionsString(QVector< DependencyGenerator * > dependencies)
Definition: DependencyGenerator.cpp:117
ExtensionGenerator::dependencyGenerators
QVector< DependencyGenerator * > dependencyGenerators
Definition: ExtensionGenerator.h:86