Computer Assited Medical Intervention Tool Kit  version 5.0
ViewerExtensionGenerator.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 VIEWEREXTENSIONGENERATOR_H
26 #define VIEWEREXTENSIONGENERATOR_H
27 
28 #if defined(_WIN32) && !defined(__MINGW32__) // MSVC only
29 #pragma warning( disable : 4290 )
30 #endif // MSVC only
31 
32 // local includes
33 #include "ExtensionGenerator.h"
34 
35 // Qt
36 #include <QStringList>
37 
38 namespace cepcoreschema {
39 class ViewerExtension;
40 }
41 
42 class ViewerGenerator;
43 
52 
53 public:
54  ViewerExtensionGenerator(QString xmlFileName, QString viewerExtensionsDirectory, QString licence = "");
55  ViewerExtensionGenerator(cepcoreschema::ViewerExtension& domViewerExtension, QString viewerExtensionsDirectory, QString licence = "");
56 
58 
59 
60 protected:
62  void generateExtensionClass(QString directory) override;
63  void writeCFile(QString directory) override;
64  void writeHFile(QString directory) override;
65 
66  void generateTestDataFiles(QString directory, QString testDataDirName) override;
67 
69 
70 private:
72  void createFromDom(cepcoreschema::ViewerExtension& dom);
73 
75 
76  QStringList namedViewers;
77 
79 };
80 
81 #endif // VIEWEREXTENSIONGENERATOR_H
ViewerGenerator.h
ViewerExtensionGenerator::registerDefaultViewer
bool registerDefaultViewer
Definition: ViewerExtensionGenerator.h:74
ViewerExtensionGenerator::createFromDom
void createFromDom(cepcoreschema::ViewerExtension &dom)
Helper method for constructors.
Definition: ViewerExtensionGenerator.cpp:73
ViewerExtensionGenerator::~ViewerExtensionGenerator
~ViewerExtensionGenerator()
Definition: ViewerExtensionGenerator.cpp:98
ExtensionGenerator::name
QString name
Name of the extension.
Definition: ExtensionGenerator.h:82
ViewerExtensionGenerator::viewerGenerator
ViewerGenerator * viewerGenerator
Definition: ViewerExtensionGenerator.h:78
DependencyGenerator.h
ViewerExtensionGenerator::namedViewers
QStringList namedViewers
Definition: ViewerExtensionGenerator.h:76
ViewerGenerator
Generate a viewer.
Definition: ViewerGenerator.h:51
ViewerExtensionGenerator
Generate an viewer extension.
Definition: ViewerExtensionGenerator.h:51
testDataDirName
static const QString testDataDirName
Definition: ExtensionGenerator.cpp:44
ViewerExtensionGenerator::generateExtensionClass
void generateExtensionClass(QString directory) override
Helpers methods.
Definition: ViewerExtensionGenerator.cpp:105
ExtensionGenerator
Common abstract class to generate extensions.
Definition: ExtensionGenerator.h:49
ViewerGenerator::getClassName
QString getClassName() const
Definition: ViewerGenerator.cpp:69
ViewerExtensionGenerator::ViewerExtensionGenerator
ViewerExtensionGenerator(QString xmlFileName, QString viewerExtensionsDirectory, QString licence="")
Definition: ViewerExtensionGenerator.cpp:50
ViewerGenerator::generateFiles
void generateFiles(QString directoryName)
Definition: ViewerGenerator.cpp:87
ViewerExtensionGenerator::writeCFile
void writeCFile(QString directory) override
Definition: ViewerExtensionGenerator.cpp:145
ViewerExtensionGenerator::generateTestDataFiles
void generateTestDataFiles(QString directory, QString testDataDirName) override
Definition: ViewerExtensionGenerator.cpp:236
registerNewViewer
#define registerNewViewer(className, instanceName)
register a new viewer, instance of X, its name is Y
Definition: ViewerExtension.h:70
ClassNameHandler.h
ViewerExtensionGenerator::writeHFile
void writeHFile(QString directory) override
Definition: ViewerExtensionGenerator.cpp:110
ClassNameHandler::getClassName
static QString getClassName(QString genericName)
Definition: ClassNameHandler.cpp:31
ViewerExtensionGenerator.h
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.h
cepcoreschema
Definition: ActionExtensionGenerator.h:36
ExtensionGenerator::dependencyGenerators
QVector< DependencyGenerator * > dependencyGenerators
Definition: ExtensionGenerator.h:88