This class contains the entry points to generate CEP.
More...
#include <CepGenerator.h>
This class contains the entry points to generate CEP.
A CEP is generated form an XML file or from a dom xml-schema.
See wiki to understand how a CEP is buildt. \nRelease 3.5: Suppose that the CEP does NOT already exist.
◆ CepGenerator() [1/3]
CepGenerator::CepGenerator |
( |
QString |
xmlFilename, |
|
|
QString |
devDirectoryName |
|
) |
| |
Create a CEPGenerator from the XML file xmlFileName
in the directory devDirectoryName
.
Supposes that the CEP does NOT exist. Create a domCep from the XML file
References initMyResource().
◆ CepGenerator() [2/3]
CepGenerator::CepGenerator |
( |
std::unique_ptr< cepcoreschema::Cep > |
domCep, |
|
|
QString |
devDirectoryName |
|
) |
| |
Create a CEPGenerator from the DOM XML-schema domCep
in the directory devDirectoryName
.
Supposes that the CEP does NOT exist.
- Note
- the CepGenerator instance takes ownership of
domCep
. When sending your unique_ptr
you need to use std::move(yourDomCep)
for the first parameter
References initMyResource().
◆ CepGenerator() [3/3]
CepGenerator::CepGenerator |
( |
| ) |
|
◆ ~CepGenerator()
CepGenerator::~CepGenerator |
( |
| ) |
|
|
virtual |
◆ copyFindCamiTK()
void CepGenerator::copyFindCamiTK |
( |
| ) |
|
|
protectedvirtual |
Generate the FindCamiTK file.
◆ createActionExtensionDoms()
void CepGenerator::createActionExtensionDoms |
( |
| ) |
|
|
protectedvirtual |
Create the ActionExtensionDom if needed and call the appropriate methods to generate the action extensions.
References cepActionsDirectoryName.
◆ createComponentExtensionDoms()
void CepGenerator::createComponentExtensionDoms |
( |
| ) |
|
|
protectedvirtual |
Create the ComponentExtensionDom if needed and call the appropriate methods to generate the component extensions.
References cepComponentsDirectoryName.
◆ createDomTree()
void CepGenerator::createDomTree |
( |
| ) |
|
Create the DOM attribute domCep from the XML CEP manifest.
◆ createLibrarieDoms()
void CepGenerator::createLibrarieDoms |
( |
| ) |
|
|
protectedvirtual |
Create the LibrariesDom if needed and call the appropriate methods to generate the libraries.
References cepLibrariesDirectoryName.
◆ createViewersExtensionDoms()
void CepGenerator::createViewersExtensionDoms |
( |
| ) |
|
|
protectedvirtual |
Create the ViewersDom if needed and call the appropriate methods to generate the viewer extensions.
References cepViewersDirectoryName.
◆ generateActionsDirectory()
void CepGenerator::generateActionsDirectory |
( |
| ) |
|
|
protectedvirtual |
◆ generateApplicationsDirectory()
void CepGenerator::generateApplicationsDirectory |
( |
| ) |
|
|
protectedvirtual |
◆ generateComponentsDirectory()
void CepGenerator::generateComponentsDirectory |
( |
| ) |
|
|
protectedvirtual |
◆ generateCopyright()
void CepGenerator::generateCopyright |
( |
| ) |
|
|
protectedvirtual |
◆ generateDirectoryTree()
void CepGenerator::generateDirectoryTree |
( |
| ) |
|
|
protectedvirtual |
Create the general directory tree (the same for every CEP).
Copies the default files in the right directories:
cepdirectoryname
|
+--- actions
|
---- CMakeLists.txt
+--- applications
|
---- CMakeLists.txt
+--- components
|
---- CMakeLists.txt
+--- libraries
|
--- CMakeLists.txt
+--- viewers
|
--- CMakeLists.txt
---- COPYRIGHT
---- CMakeLists.txt
---- FindCamiTK.cmake
---- Manifest.xml
---- README
References ClassNameHandler::getDirectoryName().
◆ generateExtensions()
void CepGenerator::generateExtensions |
( |
| ) |
|
|
protectedvirtual |
◆ generateGlobalCMakeLists()
void CepGenerator::generateGlobalCMakeLists |
( |
| ) |
|
|
protectedvirtual |
Generate CMakeLists file.
Helper methods for generateDirectoryTree
◆ generateLibrariesDirectory()
void CepGenerator::generateLibrariesDirectory |
( |
| ) |
|
|
protectedvirtual |
◆ generateReadme()
void CepGenerator::generateReadme |
( |
| ) |
|
|
protectedvirtual |
◆ generateViewersDirectory()
void CepGenerator::generateViewersDirectory |
( |
| ) |
|
|
protectedvirtual |
◆ process()
void CepGenerator::process |
( |
| ) |
|
◆ serializeManifest()
void CepGenerator::serializeManifest |
( |
QString |
fileName = "" | ) |
|
◆ setDevDirectoryName()
void CepGenerator::setDevDirectoryName |
( |
QString |
devDirectoryName | ) |
|
Where to generate the CEP directories and files.
◆ setLicence()
void CepGenerator::setLicence |
( |
| ) |
|
|
protectedvirtual |
Set the licence ine the licence
variable to be included later in the generated files.
◆ setXmlFileName()
void CepGenerator::setXmlFileName |
( |
QString |
xmlFileName | ) |
|
Set the input XML CEP manifest (ant check its xml validity)
◆ cepDirectoryName
QString CepGenerator::cepDirectoryName |
|
private |
Subdirectory where the CEP sources will be stored (updated when generating the directory tree)
◆ devDirectoryName
QDir CepGenerator::devDirectoryName |
|
private |
Where to store the produced files.
◆ domCep
std::unique_ptr<cepcoreschema::Cep> CepGenerator::domCep |
|
private |
XML DOM Element create by CodeSynthesis This cep instance contains all of the informations of the xml file.
◆ extensions
◆ licence
QString CepGenerator::licence |
|
private |
overall licence of the CEP
◆ xmlFileName
QFileInfo CepGenerator::xmlFileName |
|
private |
Where to find the original XML description of the CEP.
The documentation for this class was generated from the following files: