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