Computer Assited Medical Intervention Tool Kit  version 5.0
ActionGenerator.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 ACTIONGENERATOR_H
26 #define ACTIONGENERATOR_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 #include <QStringList>
37 
38 namespace cepcoreschema {
39 class Action;
40 }
41 
42 class ParameterGenerator;
43 
52 
53 public:
54 
59  };
60 
61  ActionGenerator(QString xmlFileName, QString licence);
62  ActionGenerator(cepcoreschema::Action& domAction, QString licence);
63 
64  ~ActionGenerator() = default;
65 
66  void generateFiles(QString directoryName);
67  QString getClassName() const;
68 private:
70  void createFromDom(cepcoreschema::Action& dom);
71 
72  void writeHFile(QString directoryName);
73  void writeCFile(QString directoryName);
74  void writeSpecialItkFile(QString directoryName);
75 
77  QString name;
78 
79  QString description;
80 
81  QString licence;
82 
83  QString className;
84 
85  QString componentName;
86 
87  QString family;
88 
89  QStringList tags;
90 
92 
94 
95  QVector<ParameterGenerator*> actionParameters;
96 
99  QString getComponentNamespace();
100 };
101 
102 #endif
ActionGenerator::writeCFile
void writeCFile(QString directoryName)
Definition: ActionGenerator.cpp:227
ActionGenerator::ActionGenerator
ActionGenerator(QString xmlFileName, QString licence)
Definition: ActionGenerator.cpp:47
ActionGenerator::isItkFilter
bool isItkFilter
Definition: ActionGenerator.h:91
ActionGenerator::ActionProperty
ActionProperty
Definition: ActionGenerator.h:55
ActionGenerator.h
ActionGenerator::writeSpecialItkFile
void writeSpecialItkFile(QString directoryName)
Definition: ActionGenerator.cpp:440
ActionGenerator::name
QString name
Name of the action.
Definition: ActionGenerator.h:77
ActionGenerator::~ActionGenerator
~ActionGenerator()=default
ActionGenerator::componentName
QString componentName
Definition: ActionGenerator.h:85
ActionGenerator::createFromDom
void createFromDom(cepcoreschema::Action &dom)
Helper methods for constructors.
Definition: ActionGenerator.cpp:83
ActionGenerator::embeded
@ embeded
Definition: ActionGenerator.h:57
ParameterGenerator
Generate parameters.
Definition: ParameterGenerator.h:48
ActionGenerator::generateFiles
void generateFiles(QString directoryName)
Definition: ActionGenerator.cpp:120
description
const char * description
Definition: applications/cepgenerator/main.cpp:38
ClassNameHandler.h
ActionGenerator::modal
@ modal
Definition: ActionGenerator.h:56
ClassNameHandler::getClassName
static QString getClassName(QString genericName)
Definition: ClassNameHandler.cpp:31
ActionGenerator::itkFilterOutputType
QString itkFilterOutputType
Definition: ActionGenerator.h:93
ActionGenerator::licence
QString licence
Definition: ActionGenerator.h:81
ActionGenerator::family
QString family
Definition: ActionGenerator.h:87
ActionGenerator::writeHFile
void writeHFile(QString directoryName)
Definition: ActionGenerator.cpp:128
ActionGenerator::delayed
@ delayed
Definition: ActionGenerator.h:58
ActionGenerator::tags
QStringList tags
Definition: ActionGenerator.h:89
ActionGenerator::getClassName
QString getClassName() const
Definition: ActionGenerator.cpp:115
ActionGenerator
Generate an action.
Definition: ActionGenerator.h:51
ActionGenerator::actionParameters
QVector< ParameterGenerator * > actionParameters
Definition: ActionGenerator.h:95
ActionGenerator::description
QString description
Definition: ActionGenerator.h:79
ActionGenerator::getComponentNamespace
QString getComponentNamespace()
Check if this action's component is in CamiTK namespace.
Definition: ActionGenerator.cpp:69
cepcoreschema
Definition: ActionExtensionGenerator.h:36
ParameterGenerator.h
ActionGenerator::className
QString className
Definition: ActionGenerator.h:83