Computer Assisted Medical Intervention Tool Kit version 6.0
 
Loading...
Searching...
No Matches
ComponentExtensionGenerator Class Reference

Generate a component extension. More...

#include <ComponentExtensionGenerator.h>

+ Inheritance diagram for ComponentExtensionGenerator:
+ Collaboration diagram for ComponentExtensionGenerator:

Public Member Functions

 ComponentExtensionGenerator (cepcoreschema::ComponentExtension &domComponentExtension, QString componentExtensionsDirectory, QString licence="")
 
 ComponentExtensionGenerator (QString xmlFileName, QString componentExtensionsDirectory, QString licence="")
 
 ~ComponentExtensionGenerator ()
 
- Public Member Functions inherited from ExtensionGenerator
 ExtensionGenerator (const QString &camitkFilePath, const QString &outputDirectoryName)
 Initialize the extension generator using the given .camitk file Note that if the outputDir does not exist, it will be created here At the end of the constructor, the camitk file is loaded in the camitkExtensionModel attribute and outputDirectoryName is a valid directory.
 
 ExtensionGenerator (QString actionExtensionsDirectory, QString licence="", QString extensionType="NONE")
 
bool generate ()
 call all methods to generate the source code Also generate CMake files and user action classes if they don't exist and the output directory is the directory of camitkFilePath (i.e.
 
virtual void generateExtension ()
 
virtual ~ExtensionGenerator ()
 
virtual ~ExtensionGenerator ()=default
 

Protected Member Functions

void generateExtensionClass (QString directory) override
 Helpers methods.
 
void writeCFile (QString directory) override
 
void writeHFile (QString directory) override
 
void generateTestDataFiles (QString directory, QString testDataDirName) override
 
- Protected Member Functions inherited from ExtensionGenerator
void setExtensionsDirectory (QString extensionsDirectory)
 
virtual void generateExtensionCMakeLists (QString directory)
 Helpers methods.
 

Additional Inherited Members

- Protected Attributes inherited from ExtensionGenerator
QVector< DependencyGenerator * > dependencyGenerators
 
QString description
 
QString extensionsDirectory
 Absolute path to the extensions directory.
 
QString extensionType
 Extension type: Action or Component extension.
 
QString licence
 
QString name
 Name of the extension.
 

Detailed Description

Generate a component extension.

Constructor & Destructor Documentation

◆ ComponentExtensionGenerator() [1/2]

ComponentExtensionGenerator::ComponentExtensionGenerator ( QString  xmlFileName,
QString  componentExtensionsDirectory,
QString  licence = "" 
)

◆ ComponentExtensionGenerator() [2/2]

ComponentExtensionGenerator::ComponentExtensionGenerator ( cepcoreschema::ComponentExtension &  domComponentExtension,
QString  componentExtensionsDirectory,
QString  licence = "" 
)

◆ ~ComponentExtensionGenerator()

ComponentExtensionGenerator::~ComponentExtensionGenerator ( )

Member Function Documentation

◆ generateExtensionClass()

void ComponentExtensionGenerator::generateExtensionClass ( QString  directory)
overrideprotectedvirtual

Helpers methods.

Implements ExtensionGenerator.

◆ generateTestDataFiles()

void ComponentExtensionGenerator::generateTestDataFiles ( QString  directory,
QString  testDataDirName 
)
overrideprotectedvirtual

Implements ExtensionGenerator.

References testDataDirName.

◆ writeCFile()

void ComponentExtensionGenerator::writeCFile ( QString  directory)
overrideprotectedvirtual

Implements ExtensionGenerator.

References ClassNameHandler::getClassName(), ExtensionGenerator::licence, and ExtensionGenerator::name.

+ Here is the call graph for this function:

◆ writeHFile()

void ComponentExtensionGenerator::writeHFile ( QString  directory)
overrideprotectedvirtual

Implements ExtensionGenerator.

References ExtensionGenerator::description, ClassNameHandler::getClassName(), ExtensionGenerator::licence, and ExtensionGenerator::name.

+ Here is the call graph for this function:

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