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

TODO Celine comment here please. More...

#include <ActionGenerator.h>

Public Types

enum  ActionProperty { modal, embeded, delayed }
 

Public Member Functions

 ActionGenerator (QString xmlFileName, QString licence) throw (QString)
 
 ActionGenerator (cepcoreschema::Action &domAction, QString licence)
 
void generateFiles (QString directoryName)
 
QString getClassName () const
 
 ~ActionGenerator ()
 

Static Public Member Functions

static bool generateActionFiles (QString xmlFileName, QString devDirectoryName, QString *elementClassName=NULL)
 

Protected Member Functions

 ActionGenerator (QString xmlFilename, QString devDirectoryName)
 
virtual void createElement () throw (QString)
 
virtual void generateActionFiles () throw (QString)
 
virtual void setDevDirectoryName (QString devDirectoryName) throw (QString)
 
virtual void setXmlFileName (QString xmlFileName) throw (QString)
 
virtual void writeCFile () throw (QString)
 
virtual void writeHFile () throw (QString)
 
virtual void writeImplementationFile () throw (QString)
 

Protected Attributes

std::set< QString > additionalIncludes
 Set of additional files to include. More...
 
QDir devDirectoryName
 Where to store the produced files. More...
 
bool hasParameters
 Does the action have parameters stored as properties ? More...
 
QMap< QString, QPair< QString,
QString > > 
parameters
 List containing all parameters of the action stored as properties of theAction For practical reasons, this map contains for each parameter: More...
 
std::auto_ptr< coreschema::ActiontheAction
 XML DOM Element create by CodeSynthesis This action contains all of the informations of the xml file. More...
 
QFileInfo xmlFileName
 Where to find the XML description of the Action. More...
 

Private Member Functions

void createFromDom (cepcoreschema::Action &dom)
 Helper methods for constructors. More...
 
void writeCFile (QString directoryName)
 
void writeHFile (QString directoryName)
 
void writeSpecialItkFile (QString directoryName)
 

Private Attributes

QVector< ParameterGenerator * > actionParameters
 
QString className
 Name of the created Action class redundant information already contained in theAction, for practicle purpose. More...
 
QString componentName
 
QString description
 
QString family
 
bool isItkFilter
 
QString itkFilterOutputType
 
QString licence
 
QString name
 Name of the action. More...
 
QStringList tags
 

Detailed Description

TODO Celine comment here please.

Constructor & Destructor Documentation

ActionGenerator::ActionGenerator ( QString  xmlFileName,
QString  licence 
)
throw (QString
)
ActionGenerator::ActionGenerator ( cepcoreschema::Action domAction,
QString  licence 
)
ActionGenerator::~ActionGenerator ( )
ActionGenerator::ActionGenerator ( QString  xmlFilename,
QString  devDirectoryName 
)
protected

Member Function Documentation

virtual void ActionGenerator::createElement ( )
throw (QString
)
protectedvirtual
void ActionGenerator::createFromDom ( cepcoreschema::Action dom)
private

Helper methods for constructors.

static bool ActionGenerator::generateActionFiles ( QString  xmlFileName,
QString  devDirectoryName,
QString *  elementClassName = NULL 
)
static
virtual void ActionGenerator::generateActionFiles ( )
throw (QString
)
protectedvirtual
void ActionGenerator::generateFiles ( QString  directoryName)
QString ActionGenerator::getClassName ( ) const
virtual void ActionGenerator::setDevDirectoryName ( QString  devDirectoryName)
throw (QString
)
protectedvirtual
virtual void ActionGenerator::setXmlFileName ( QString  xmlFileName)
throw (QString
)
protectedvirtual
virtual void ActionGenerator::writeCFile ( )
throw (QString
)
protectedvirtual
void ActionGenerator::writeCFile ( QString  directoryName)
private
virtual void ActionGenerator::writeHFile ( )
throw (QString
)
protectedvirtual
void ActionGenerator::writeHFile ( QString  directoryName)
private
virtual void ActionGenerator::writeImplementationFile ( )
throw (QString
)
protectedvirtual
void ActionGenerator::writeSpecialItkFile ( QString  directoryName)
private

Member Data Documentation

QVector<ParameterGenerator *> ActionGenerator::actionParameters
private
std::set<QString> ActionGenerator::additionalIncludes
protected

Set of additional files to include.

QString ActionGenerator::className
private

Name of the created Action class redundant information already contained in theAction, for practicle purpose.

QString ActionGenerator::componentName
private
QString ActionGenerator::description
private
QDir ActionGenerator::devDirectoryName
protected

Where to store the produced files.

QString ActionGenerator::family
private
bool ActionGenerator::hasParameters
protected

Does the action have parameters stored as properties ?

bool ActionGenerator::isItkFilter
private
QString ActionGenerator::itkFilterOutputType
private
QString ActionGenerator::licence
private
QString ActionGenerator::name
private

Name of the action.

QMap<QString, QPair<QString, QString> > ActionGenerator::parameters
protected

List containing all parameters of the action stored as properties of theAction For practical reasons, this map contains for each parameter:

  • key: the name of the parameter
  • value: a QPair of element:
    • first: the type of the parameter
    • second: the default value of the parameter (if non exists in the XML file, a default one is given)
QStringList ActionGenerator::tags
private
std::auto_ptr<coreschema::Action> ActionGenerator::theAction
protected

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

QFileInfo ActionGenerator::xmlFileName
protected

Where to find the XML description of the Action.


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