Computer Assisted Medical Intervention Tool Kit  version 5.2
 
Loading...
Searching...
No Matches
ExtensionGenerator Class Referenceabstract

Common abstract class to generate extensions. More...

#include <ExtensionGenerator.h>

+ Inheritance diagram for ExtensionGenerator:
+ Collaboration diagram for ExtensionGenerator:

Public Member Functions

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

Protected Member Functions

void setExtensionsDirectory (QString extensionsDirectory)
 
virtual void generateExtensionCMakeLists (QString directory)
 Helpers methods.
 
virtual void generateExtensionClass (QString directory)=0
 generate an action, a component of a viewer
 
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
 
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

Common abstract class to generate extensions.

Note
This class is abstract and thus cannot be instantiated.

Constructor & Destructor Documentation

◆ ExtensionGenerator()

ExtensionGenerator::ExtensionGenerator ( QString  actionExtensionsDirectory,
QString  licence = "",
QString  extensionType = "NONE" 
)

References extensionsDirectory, extensionType, licence, and setExtensionsDirectory().

+ Here is the call graph for this function:

◆ ~ExtensionGenerator()

ExtensionGenerator::~ExtensionGenerator ( )
virtual

Member Function Documentation

◆ generateExtension()

void ExtensionGenerator::generateExtension ( )
virtual

References extensionsDirectory, generateExtensionClass(), generateExtensionCMakeLists(), generateTestDataFiles(), name, testDataDirName, writeCFile(), and writeHFile().

+ Here is the call graph for this function:

◆ generateExtensionClass()

virtual void ExtensionGenerator::generateExtensionClass ( QString  directory)
protectedpure virtual

generate an action, a component of a viewer

Implemented in ActionExtensionGenerator, ComponentExtensionGenerator, LibraryGenerator, and ViewerExtensionGenerator.

Referenced by generateExtension().

+ Here is the caller graph for this function:

◆ generateExtensionCMakeLists()

void ExtensionGenerator::generateExtensionCMakeLists ( QString  directory)
protectedvirtual

Helpers methods.

Reimplemented in LibraryGenerator.

References dependencyGenerators, description, extensionType, DependencyGenerator::getCepLibsString(), DependencyGenerator::getExternalLibsString(), DependencyGenerator::getNeededActionsString(), DependencyGenerator::getNeededComponentsString(), and DependencyGenerator::getNeededViewersString().

Referenced by generateExtension().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ generateTestDataFiles()

virtual void ExtensionGenerator::generateTestDataFiles ( QString  directory,
QString  testDataDirName 
)
protectedpure virtual

Implemented in ActionExtensionGenerator, ComponentExtensionGenerator, LibraryGenerator, and ViewerExtensionGenerator.

Referenced by generateExtension().

+ Here is the caller graph for this function:

◆ setExtensionsDirectory()

void ExtensionGenerator::setExtensionsDirectory ( QString  extensionsDirectory)
protected

References extensionsDirectory.

Referenced by ExtensionGenerator().

+ Here is the caller graph for this function:

◆ writeCFile()

virtual void ExtensionGenerator::writeCFile ( QString  directory)
protectedpure virtual

Implemented in ActionExtensionGenerator, ComponentExtensionGenerator, LibraryGenerator, and ViewerExtensionGenerator.

Referenced by generateExtension().

+ Here is the caller graph for this function:

◆ writeHFile()

virtual void ExtensionGenerator::writeHFile ( QString  directory)
protectedpure virtual

Implemented in ActionExtensionGenerator, ComponentExtensionGenerator, LibraryGenerator, and ViewerExtensionGenerator.

Referenced by generateExtension().

+ Here is the caller graph for this function:

Member Data Documentation

◆ dependencyGenerators

QVector<DependencyGenerator* > ExtensionGenerator::dependencyGenerators
protected

◆ description

◆ extensionsDirectory

QString ExtensionGenerator::extensionsDirectory
protected

Absolute path to the extensions directory.

Referenced by ExtensionGenerator(), generateExtension(), and setExtensionsDirectory().

◆ extensionType

QString ExtensionGenerator::extensionType
protected

Extension type: Action or Component extension.

Referenced by ExtensionGenerator(), and generateExtensionCMakeLists().

◆ licence

◆ name


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