Computer Assited Medical Intervention Tool Kit  version 5.0
ComponentExtensionGenerator.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 COMPONENTEXTENSIONGENERATOR_H
26 #define COMPONENTEXTENSIONGENERATOR_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 // local includes
38 #include "ExtensionGenerator.h"
39 
40 namespace cepcoreschema {
41 class ComponentExtension;
42 }
43 
44 class ComponentGenerator;
45 
54 
55 public:
56  ComponentExtensionGenerator(QString xmlFileName, QString componentExtensionsDirectory, QString licence = "");
57  ComponentExtensionGenerator(cepcoreschema::ComponentExtension& domComponentExtension, QString componentExtensionsDirectory, QString licence = "");
58 
60 
61 
62 protected:
64  void generateExtensionClass(QString directory) override;
65  void writeCFile(QString directory) override;
66  void writeHFile(QString directory) override;
67 
68  void generateTestDataFiles(QString directory, QString testDataDirName) override;
69 
71 
72 private:
74  void createFromDom(cepcoreschema::ComponentExtension& dom);
75 
76  QString findComponentClass(QString suffix);
77 
78  QVector<ComponentGenerator*> components;
79 
80 };
81 
82 #endif
ComponentExtensionGenerator::~ComponentExtensionGenerator
~ComponentExtensionGenerator()
Definition: ComponentExtensionGenerator.cpp:93
ComponentGenerator
Create a component.
Definition: ComponentGenerator.h:53
ComponentExtensionGenerator::generateExtensionClass
void generateExtensionClass(QString directory) override
Helpers methods.
Definition: ComponentExtensionGenerator.cpp:100
ExtensionGenerator::name
QString name
Name of the extension.
Definition: ExtensionGenerator.h:82
ComponentExtensionGenerator::findComponentClass
QString findComponentClass(QString suffix)
Definition: ComponentExtensionGenerator.cpp:281
DependencyGenerator.h
testDataDirName
static const QString testDataDirName
Definition: ExtensionGenerator.cpp:44
ComponentExtensionGenerator::writeHFile
void writeHFile(QString directory) override
Definition: ComponentExtensionGenerator.cpp:108
ExtensionGenerator
Common abstract class to generate extensions.
Definition: ExtensionGenerator.h:49
ComponentGenerator.h
ComponentExtensionGenerator.h
ComponentExtensionGenerator::createFromDom
void createFromDom(cepcoreschema::ComponentExtension &dom)
Helper method for constructors.
Definition: ComponentExtensionGenerator.cpp:70
ComponentExtensionGenerator::components
QVector< ComponentGenerator * > components
Definition: ComponentExtensionGenerator.h:78
ClassNameHandler.h
ComponentExtensionGenerator
Generate a component extension.
Definition: ComponentExtensionGenerator.h:53
ClassNameHandler::getClassName
static QString getClassName(QString genericName)
Definition: ClassNameHandler.cpp:31
ComponentExtensionGenerator::generateTestDataFiles
void generateTestDataFiles(QString directory, QString testDataDirName) override
Definition: ComponentExtensionGenerator.cpp:295
Component
A component is something that composed something and could also be a part of something.
Definition: modeling/libraries/pml/Component.h:48
ComponentExtensionGenerator::writeCFile
void writeCFile(QString directory) override
Definition: ComponentExtensionGenerator.cpp:139
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
ComponentExtensionGenerator::ComponentExtensionGenerator
ComponentExtensionGenerator(QString xmlFileName, QString componentExtensionsDirectory, QString licence="")
Definition: ComponentExtensionGenerator.cpp:49
ExtensionGenerator.h
cepcoreschema
Definition: ActionExtensionGenerator.h:36
ExtensionGenerator::dependencyGenerators
QVector< DependencyGenerator * > dependencyGenerators
Definition: ExtensionGenerator.h:88