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

TODO Celine comment here please. More...

#include <ExtensionGenerator.h>

+ Inheritance diagram for ExtensionGenerator:

Public Types

enum  ExtensionType {
  ACTION, APPLICATION, COMPONENT, VIEWER,
  UNKNOWN
}
 

Public Member Functions

 ExtensionGenerator (QString actionExtensionsDirectory, QString licence="", QString extensionType="NONE")
 
virtual void generateExtension ()
 
 ~ExtensionGenerator ()
 

Static Public Member Functions

static bool generateExtensionFiles (QString xmlFileName, QString devDirectoryName)
 

Protected Member Functions

void createTestDataFiles () throw (QString)
 
 ExtensionGenerator (QString xmlFileName, QString devDirectoryName) throw (QString)
 
void generateActionExtensionFiles () throw (QString)
 
void generateActionFiles () throw (QString)
 
void generateActionsList () throw (QString)
 
void generateCMakeLists () throw (QString)
 
void generateComponentExtensionFiles () throw (QString)
 
void generateComponentFiles () throw (QString)
 
void generateComponentsList () throw (QString)
 
void generateExtensionFiles () throw (QString)
 
void generateInternFiles () throw (QString)
 
void generateInternFilesList () throw (QString)
 
void setDevDirectoryName (QString devDirectoryName) throw (QString)
 
virtual void setExtensionsDirectory (QString extensionsDirectory)
 
void setXmlFileName (QString xmlFileName) throw (QString)
 
void showReport ()
 
void writeReport ()
 
virtual void generateExtensionCMakeLists (QString directory)
 Helpers methods. More...
 
virtual void generateActionOrComponent (QString directory)=0
 
virtual void writeCFile (QString directory)=0
 
virtual void writeHFile (QString directory)=0
 
virtual void generateTestDataFiles (QString directory, QString testDataDirName)=0
 

Protected Attributes

QVector< DependencyGenerator * > dependencyGenerators
 
QString description
 
QDir devDirectoryName
 
std::vector< QFileInfo > elementsList
 
QString extensionsDirectory
 Absolute path to the extensions directory. More...
 
QString extensionType
 Extension type: Action or Component extension. More...
 
std::vector< QString > generatedClassList
 
QString licence
 
QString name
 Name of the extension. More...
 
QDir srcDir
 
std::auto_ptr
< coreschema::Extension > 
theExtension
 
ExtensionType type
 
QFileInfo xmlFileName
 

Detailed Description

TODO Celine comment here please.

Note
This class is abstract and thus cannot be instanciated.

Member Enumeration Documentation

Enumerator
ACTION 
APPLICATION 
COMPONENT 
VIEWER 
UNKNOWN 

Constructor & Destructor Documentation

ExtensionGenerator::ExtensionGenerator ( QString  actionExtensionsDirectory,
QString  licence = "",
QString  extensionType = "NONE" 
)
ExtensionGenerator::~ExtensionGenerator ( )
ExtensionGenerator::ExtensionGenerator ( QString  xmlFileName,
QString  devDirectoryName 
)
throw (QString
)
protected

Member Function Documentation

void ExtensionGenerator::createTestDataFiles ( )
throw (QString
)
protected
void ExtensionGenerator::generateActionExtensionFiles ( )
throw (QString
)
protected
void ExtensionGenerator::generateActionFiles ( )
throw (QString
)
protected
virtual void ExtensionGenerator::generateActionOrComponent ( QString  directory)
protectedpure virtual
void ExtensionGenerator::generateActionsList ( )
throw (QString
)
protected
void ExtensionGenerator::generateCMakeLists ( )
throw (QString
)
protected
void ExtensionGenerator::generateComponentExtensionFiles ( )
throw (QString
)
protected
void ExtensionGenerator::generateComponentFiles ( )
throw (QString
)
protected
void ExtensionGenerator::generateComponentsList ( )
throw (QString
)
protected
virtual void ExtensionGenerator::generateExtension ( )
virtual
virtual void ExtensionGenerator::generateExtensionCMakeLists ( QString  directory)
protectedvirtual

Helpers methods.

Reimplemented in LibraryGenerator.

static bool ExtensionGenerator::generateExtensionFiles ( QString  xmlFileName,
QString  devDirectoryName 
)
static
void ExtensionGenerator::generateExtensionFiles ( )
throw (QString
)
protected
void ExtensionGenerator::generateInternFiles ( )
throw (QString
)
protected
void ExtensionGenerator::generateInternFilesList ( )
throw (QString
)
protected
virtual void ExtensionGenerator::generateTestDataFiles ( QString  directory,
QString  testDataDirName 
)
protectedpure virtual
void ExtensionGenerator::setDevDirectoryName ( QString  devDirectoryName)
throw (QString
)
protected
virtual void ExtensionGenerator::setExtensionsDirectory ( QString  extensionsDirectory)
protectedvirtual
void ExtensionGenerator::setXmlFileName ( QString  xmlFileName)
throw (QString
)
protected
void ExtensionGenerator::showReport ( )
protected
virtual void ExtensionGenerator::writeCFile ( QString  directory)
protectedpure virtual
virtual void ExtensionGenerator::writeHFile ( QString  directory)
protectedpure virtual
void ExtensionGenerator::writeReport ( )
protected

Member Data Documentation

QVector<DependencyGenerator * > ExtensionGenerator::dependencyGenerators
protected
QString ExtensionGenerator::description
protected
QDir ExtensionGenerator::devDirectoryName
protected
std::vector<QFileInfo> ExtensionGenerator::elementsList
protected
QString ExtensionGenerator::extensionsDirectory
protected

Absolute path to the extensions directory.

QString ExtensionGenerator::extensionType
protected

Extension type: Action or Component extension.

std::vector<QString> ExtensionGenerator::generatedClassList
protected
QString ExtensionGenerator::licence
protected
QString ExtensionGenerator::name
protected

Name of the extension.

QDir ExtensionGenerator::srcDir
protected
std::auto_ptr<coreschema::Extension> ExtensionGenerator::theExtension
protected
ExtensionType ExtensionGenerator::type
protected
QFileInfo ExtensionGenerator::xmlFileName
protected

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