Computer Assited Medical Intervention Tool Kit  version 5.0
ViewerExtensionGenerator Class Reference

Generate an viewer extension. More...

#include <ViewerExtensionGenerator.h>

+ Inheritance diagram for ViewerExtensionGenerator:
+ Collaboration diagram for ViewerExtensionGenerator:

Public Member Functions

 ViewerExtensionGenerator (cepcoreschema::ViewerExtension &domViewerExtension, QString viewerExtensionsDirectory, QString licence="")
 
 ViewerExtensionGenerator (QString xmlFileName, QString viewerExtensionsDirectory, QString licence="")
 
 ~ViewerExtensionGenerator ()
 
- Public Member Functions inherited from ExtensionGenerator
 ExtensionGenerator (QString actionExtensionsDirectory, QString licence="", QString extensionType="NONE")
 
virtual void generateExtension ()
 
virtual ~ExtensionGenerator ()
 

Protected Member Functions

void generateExtensionClass (QString directory) override
 Helpers methods. More...
 
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. More...
 

Private Member Functions

void createFromDom (cepcoreschema::ViewerExtension &dom)
 Helper method for constructors. More...
 

Private Attributes

QStringList namedViewers
 
bool registerDefaultViewer
 
ViewerGeneratorviewerGenerator
 

Additional Inherited Members

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

Detailed Description

Generate an viewer extension.

Constructor & Destructor Documentation

◆ ViewerExtensionGenerator() [1/2]

ViewerExtensionGenerator::ViewerExtensionGenerator ( QString  xmlFileName,
QString  viewerExtensionsDirectory,
QString  licence = "" 
)

References createFromDom().

+ Here is the call graph for this function:

◆ ViewerExtensionGenerator() [2/2]

ViewerExtensionGenerator::ViewerExtensionGenerator ( cepcoreschema::ViewerExtension &  domViewerExtension,
QString  viewerExtensionsDirectory,
QString  licence = "" 
)

◆ ~ViewerExtensionGenerator()

ViewerExtensionGenerator::~ViewerExtensionGenerator ( )

Member Function Documentation

◆ createFromDom()

void ViewerExtensionGenerator::createFromDom ( cepcoreschema::ViewerExtension &  dom)
private

Helper method for constructors.

References ExtensionGenerator::dependencyGenerators, ExtensionGenerator::description, ExtensionGenerator::licence, ExtensionGenerator::name, namedViewers, registerDefaultViewer, and viewerGenerator.

Referenced by ViewerExtensionGenerator().

+ Here is the caller graph for this function:

◆ generateExtensionClass()

void ViewerExtensionGenerator::generateExtensionClass ( QString  directory)
overrideprotectedvirtual

Helpers methods.

Implements ExtensionGenerator.

References ViewerGenerator::generateFiles(), and viewerGenerator.

+ Here is the call graph for this function:

◆ generateTestDataFiles()

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

Implements ExtensionGenerator.

◆ writeCFile()

void ViewerExtensionGenerator::writeCFile ( QString  directory)
overrideprotectedvirtual

Implements ExtensionGenerator.

References ViewerGenerator::getClassName(), ClassNameHandler::getClassName(), ExtensionGenerator::licence, ExtensionGenerator::name, namedViewers, registerDefaultViewer, registerNewViewer, and viewerGenerator.

+ Here is the call graph for this function:

◆ writeHFile()

void ViewerExtensionGenerator::writeHFile ( QString  directory)
overrideprotectedvirtual

Implements ExtensionGenerator.

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

+ Here is the call graph for this function:

Member Data Documentation

◆ namedViewers

QStringList ViewerExtensionGenerator::namedViewers
private

Referenced by createFromDom(), and writeCFile().

◆ registerDefaultViewer

bool ViewerExtensionGenerator::registerDefaultViewer
private

Referenced by createFromDom(), and writeCFile().

◆ viewerGenerator

ViewerGenerator* ViewerExtensionGenerator::viewerGenerator
private

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