Computer Assited Medical Intervention Tool Kit  version 3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
CepGenerator Class Reference

TODO Celine comment here please. More...

#include <CepGenerator.h>

Static Public Member Functions

static bool generateCEP (QString xmlFileName, QString devDirectoryName)
 Supposes that the CEP does NOT exist. More...
 
static bool generateCEP (std::auto_ptr< cepcoreschema::Cep > domCep, QString devDirectoryName)
 Supposes that the CEP does NOT exist. More...
 

Protected Member Functions

 CepGenerator (QString xmlFilename, QString devDirectoryName)
 
 CepGenerator (std::auto_ptr< cepcoreschema::Cep > domCep, QString devDirectoryName)
 
virtual void createActionExtensionDoms ()
 
virtual void createComponentExtensionDoms ()
 
virtual void createLibrarieDoms ()
 
virtual void generateDirectoryTree () throw (QString)
 Create the general directory tree (the same for every CEP) Copies the default files in the right directories: More...
 
virtual void generateExtensions ()
 
virtual void setDevDirectoryName (QString devDirectoryName) throw (QString)
 Where to generate the CEP directories and files. More...
 
virtual void setXmlFileName (QString xmlFileName) throw (QString)
 Set the input XML CEP manifest (ant check its xml validity) More...
 
 ~CepGenerator ()
 
virtual void serializeManifest ()
 
virtual void generateGlobalCMakeLists ()
 
virtual void generateCopyright ()
 
virtual void generateReadme ()
 
virtual void copyFindCamiTK ()
 
virtual void generateActionsDirectory ()
 
virtual void generateApplicationsDirectory ()
 
virtual void generateComponentsDirectory ()
 
virtual void generateLibrariesDirectory ()
 
virtual void setLicence ()
 

Private Member Functions

virtual void createDomTree () throw (QString)
 Create the DOM attribute domCep from the XML CEP manifest. More...
 

Private Attributes

QString cepDirectoryName
 Subdirectory where the CEP sources will be stored (updated when generating the directory tree) More...
 
QDir devDirectoryName
 Where to store the produced files. More...
 
std::auto_ptr< cepcoreschema::Cep > domCep
 XML DOM Element create by CodeSynthesis This cep instance contains all of the informations of the xml file. More...
 
QVector< ExtensionGenerator * > extensions
 Action or Component Extensions. More...
 
QString licence
 Action Extensions. More...
 
QFileInfo xmlFileName
 Where to find the original XML description of the CEP. More...
 

Detailed Description

TODO Celine comment here please.

Constructor & Destructor Documentation

CepGenerator::CepGenerator ( QString  xmlFilename,
QString  devDirectoryName 
)
protected
CepGenerator::CepGenerator ( std::auto_ptr< cepcoreschema::Cep >  domCep,
QString  devDirectoryName 
)
protected
CepGenerator::~CepGenerator ( )
protected

Member Function Documentation

virtual void CepGenerator::copyFindCamiTK ( )
protectedvirtual
virtual void CepGenerator::createActionExtensionDoms ( )
protectedvirtual
virtual void CepGenerator::createComponentExtensionDoms ( )
protectedvirtual
virtual void CepGenerator::createDomTree ( )
throw (QString
)
privatevirtual

Create the DOM attribute domCep from the XML CEP manifest.

virtual void CepGenerator::createLibrarieDoms ( )
protectedvirtual
virtual void CepGenerator::generateActionsDirectory ( )
protectedvirtual
virtual void CepGenerator::generateApplicationsDirectory ( )
protectedvirtual
static bool CepGenerator::generateCEP ( QString  xmlFileName,
QString  devDirectoryName 
)
static

Supposes that the CEP does NOT exist.

static bool CepGenerator::generateCEP ( std::auto_ptr< cepcoreschema::Cep >  domCep,
QString  devDirectoryName 
)
static

Supposes that the CEP does NOT exist.

virtual void CepGenerator::generateComponentsDirectory ( )
protectedvirtual
virtual void CepGenerator::generateCopyright ( )
protectedvirtual
virtual void CepGenerator::generateDirectoryTree ( )
throw (QString
)
protectedvirtual

Create the general directory tree (the same for every CEP) Copies the default files in the right directories:

cepdirectoryname | +— actions | -— CMakeLists.txt --— CMakeLists.txt +— components | -— CMakeLists.txt -— COPYRIGHT -— FindCamiTK.cmake +— libraries | — CMakeLists.txt -— Manifest.xml -— README

virtual void CepGenerator::generateExtensions ( )
protectedvirtual
virtual void CepGenerator::generateGlobalCMakeLists ( )
protectedvirtual
virtual void CepGenerator::generateLibrariesDirectory ( )
protectedvirtual
virtual void CepGenerator::generateReadme ( )
protectedvirtual
virtual void CepGenerator::serializeManifest ( )
protectedvirtual

Helping Functions for generateDirectoryTree

virtual void CepGenerator::setDevDirectoryName ( QString  devDirectoryName)
throw (QString
)
protectedvirtual

Where to generate the CEP directories and files.

virtual void CepGenerator::setLicence ( )
protectedvirtual
virtual void CepGenerator::setXmlFileName ( QString  xmlFileName)
throw (QString
)
protectedvirtual

Set the input XML CEP manifest (ant check its xml validity)

Member Data Documentation

QString CepGenerator::cepDirectoryName
private

Subdirectory where the CEP sources will be stored (updated when generating the directory tree)

QDir CepGenerator::devDirectoryName
private

Where to store the produced files.

std::auto_ptr<cepcoreschema::Cep> CepGenerator::domCep
private

XML DOM Element create by CodeSynthesis This cep instance contains all of the informations of the xml file.

QVector<ExtensionGenerator *> CepGenerator::extensions
private

Action or Component Extensions.

QString CepGenerator::licence
private

Action Extensions.

Component Extensions

QFileInfo CepGenerator::xmlFileName
private

Where to find the original XML description of the CEP.


The documentation for this class was generated from the following file: