Computer Assited Medical Intervention Tool Kit  version 5.0
ComponentGenerator.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 COMPONENTGENERATOR_H
26 #define COMPONENTGENERATOR_H
27 
28 #if defined(_WIN32) && !defined(__MINGW32__) // MSVC only
29 #pragma warning( disable : 4290 )
30 #endif // MSVC only
31 
32 // includes from STL
33 #include <set>
34 // includes from Qt
35 #include <QString>
36 #include <QVector>
37 #include <QStringList>
38 
39 namespace cepcoreschema {
40 class Component;
41 }
42 
43 class ParameterGenerator;
44 
45 
54 
55 public:
56  ComponentGenerator(QString xmlFileName, QString licence);
57  ComponentGenerator(cepcoreschema::Component& domComponent, QString licence);
58 
59  ~ComponentGenerator() = default;
60 
61  void generateFiles(QString directoryName);
62 
63  QString getClassName() const;
64 
65  QStringList getSuffixesList();
66 
67 private:
69  void createFromDom(cepcoreschema::Component& dom);
70 
71  void writeHFile(QString directoryName);
72  void writeCFile(QString directoryName);
73 
74  QString getParentClassName();
75 
77  QString name;
78 
79  QString description;
80 
81  QString className;
82 
83  QString representation;
84 
85  QString licence;
86 
87  QVector<ParameterGenerator*> componentProperties;
88 
89  QStringList suffixesList;
90 
91 };
92 
93 #endif
ComponentGenerator::representation
QString representation
Definition: ComponentGenerator.h:83
Properties::get
void get(std::string attName, std::string &attVal) const
field accessor: get the field attName as a string value in attVal, if field does not exist,...
Definition: Properties.h:189
ComponentGenerator::getParentClassName
QString getParentClassName()
Definition: ComponentGenerator.cpp:108
ComponentGenerator
Create a component.
Definition: ComponentGenerator.h:53
ComponentGenerator::ComponentGenerator
ComponentGenerator(QString xmlFileName, QString licence)
Definition: ComponentGenerator.cpp:48
ComponentGenerator::description
QString description
Definition: ComponentGenerator.h:79
ComponentGenerator::className
QString className
Definition: ComponentGenerator.h:81
Component::properties
Properties * properties
Definition: modeling/libraries/pml/Component.h:118
ComponentGenerator::licence
QString licence
Definition: ComponentGenerator.h:85
ComponentGenerator::getSuffixesList
QStringList getSuffixesList()
Definition: ComponentGenerator.cpp:99
ComponentGenerator::~ComponentGenerator
~ComponentGenerator()=default
ComponentGenerator.h
ComponentGenerator::suffixesList
QStringList suffixesList
Definition: ComponentGenerator.h:89
ComponentGenerator::writeHFile
void writeHFile(QString directoryName)
Definition: ComponentGenerator.cpp:127
ComponentGenerator::writeCFile
void writeCFile(QString directoryName)
Definition: ComponentGenerator.cpp:187
ParameterGenerator
Generate parameters.
Definition: ParameterGenerator.h:48
description
const char * description
Definition: applications/cepgenerator/main.cpp:38
ClassNameHandler.h
ClassNameHandler::getClassName
static QString getClassName(QString genericName)
Definition: ClassNameHandler.cpp:31
ComponentGenerator::name
QString name
Name of the action.
Definition: ComponentGenerator.h:77
Component
A component is something that composed something and could also be a part of something.
Definition: modeling/libraries/pml/Component.h:48
ComponentGenerator::generateFiles
void generateFiles(QString directoryName)
Definition: ComponentGenerator.cpp:103
ComponentGenerator::createFromDom
void createFromDom(cepcoreschema::Component &dom)
Helper methods for constructors.
Definition: ComponentGenerator.cpp:70
cepcoreschema
Definition: ActionExtensionGenerator.h:36
ParameterGenerator.h
ComponentGenerator::getClassName
QString getClassName() const
Definition: ComponentGenerator.cpp:95
ComponentGenerator::componentProperties
QVector< ParameterGenerator * > componentProperties
Definition: ComponentGenerator.h:87