This class contains the entry points to generate CEP. More...
#include <CepGenerator.h>
Public Member Functions | |
CepGenerator () | |
Create an empty CepGenerator. More... | |
CepGenerator (QString xmlFilename, QString devDirectoryName) | |
Create a CEPGenerator from the XML file xmlFileName in the directory devDirectoryName . More... | |
CepGenerator (std::unique_ptr< cepcoreschema::Cep > domCep, QString devDirectoryName) | |
Create a CEPGenerator from the DOM XML-schema domCep in the directory devDirectoryName . More... | |
void | createDomTree () |
Create the DOM attribute domCep from the XML CEP manifest. More... | |
void | process () |
call all methods to generate the CEP from the DomTree. More... | |
void | serializeManifest (QString fileName="") |
Serialize the manifest ie serialize the domCep to a std::string. More... | |
void | setDevDirectoryName (QString devDirectoryName) |
Where to generate the CEP directories and files. More... | |
void | setXmlFileName (QString xmlFileName) |
Set the input XML CEP manifest (ant check its xml validity) More... | |
virtual | ~CepGenerator () |
Protected Member Functions | |
virtual void | createActionExtensionDoms () |
Create the ActionExtensionDom if needed and call the appropriate methods to generate the action extensions. More... | |
virtual void | createComponentExtensionDoms () |
Create the ComponentExtensionDom if needed and call the appropriate methods to generate the component extensions. More... | |
virtual void | createLibrarieDoms () |
Create the LibrariesDom if needed and call the appropriate methods to generate the libraries. More... | |
virtual void | createViewersExtensionDoms () |
Create the ViewersDom if needed and call the appropriate methods to generate the viewer extensions. More... | |
virtual void | generateDirectoryTree () |
Create the general directory tree (the same for every CEP). More... | |
virtual void | generateExtensions () |
virtual void | generateGlobalCMakeLists () |
Generate CMakeLists file. More... | |
virtual void | generateCopyright () |
Generate copyright file. More... | |
virtual void | generateReadme () |
Generate Readme File. More... | |
virtual void | copyFindCamiTK () |
Generate the FindCamiTK file. More... | |
virtual void | generateActionsDirectory () |
Generate the Actions directory. More... | |
virtual void | generateApplicationsDirectory () |
Generate the Applications directory. More... | |
virtual void | generateComponentsDirectory () |
Generate the Components directory. More... | |
virtual void | generateLibrariesDirectory () |
Generate the Libraries directory. More... | |
virtual void | generateViewersDirectory () |
Generate the Libraries directory. More... | |
virtual void | setLicence () |
Set the licence ine the licence variable to be included later in the generated files. More... | |
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::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::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.
domCep
. When sending your unique_ptr
you need to use std::move(yourDomCep)
for the first parameter References initMyResource().
CepGenerator::CepGenerator | ( | ) |
Create an empty CepGenerator.
References initMyResource().
|
virtual |
|
protectedvirtual |
Generate the FindCamiTK file.
|
protectedvirtual |
Create the ActionExtensionDom if needed and call the appropriate methods to generate the action extensions.
References cepActionsDirectoryName.
|
protectedvirtual |
Create the ComponentExtensionDom if needed and call the appropriate methods to generate the component extensions.
References cepComponentsDirectoryName.
void CepGenerator::createDomTree | ( | ) |
Create the DOM attribute domCep from the XML CEP manifest.
|
protectedvirtual |
Create the LibrariesDom if needed and call the appropriate methods to generate the libraries.
References cepLibrariesDirectoryName.
|
protectedvirtual |
Create the ViewersDom if needed and call the appropriate methods to generate the viewer extensions.
References cepViewersDirectoryName.
|
protectedvirtual |
Generate the Actions directory.
References cepActionsDirectoryName.
|
protectedvirtual |
Generate the Applications directory.
References cepApplicationsDirectoryName.
|
protectedvirtual |
Generate the Components directory.
References cepComponentsDirectoryName.
|
protectedvirtual |
Generate copyright file.
|
protectedvirtual |
Create the general directory tree (the same for every CEP).
Copies the default files in the right directories:
References ClassNameHandler::getDirectoryName().
|
protectedvirtual |
|
protectedvirtual |
Generate CMakeLists file.
Helper methods for generateDirectoryTree
|
protectedvirtual |
Generate the Libraries directory.
References cepLibrariesDirectoryName.
|
protectedvirtual |
Generate Readme File.
|
protectedvirtual |
Generate the Libraries directory.
References cepViewersDirectoryName.
void CepGenerator::process | ( | ) |
call all methods to generate the CEP from the DomTree.
Referenced by main(), and GeneratingCEPState::onEntry().
void CepGenerator::serializeManifest | ( | QString | fileName = "" | ) |
Serialize the manifest ie serialize the domCep to a std::string.
References cepManifestExtension, cepManifestName, and cepSchemaNamespace.
void CepGenerator::setDevDirectoryName | ( | QString | devDirectoryName | ) |
Where to generate the CEP directories and files.
|
protectedvirtual |
Set the licence ine the licence
variable to be included later in the generated files.
void CepGenerator::setXmlFileName | ( | QString | xmlFileName | ) |
Set the input XML CEP manifest (ant check its xml validity)