ViewerExtensionGenerator Class Reference

Generate an viewer extension. More...

#include <ViewerExtensionGenerator.h>

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 (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 an viewer extension.

Constructor & Destructor Documentation

ViewerExtensionGenerator() [1/2]

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

References ExtensionGenerator::ExtensionGenerator(), and ExtensionGenerator::licence.

ViewerExtensionGenerator() [2/2]

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

References ExtensionGenerator::licence, and testDataDirName.

~ViewerExtensionGenerator()

ViewerExtensionGenerator::~ViewerExtensionGenerator

(

)

Member Function Documentation

generateExtensionClass()

void ViewerExtensionGenerator::generateExtensionClass ( QString directory )

overrideprotectedvirtual

Helpers methods.

Implements ExtensionGenerator.

generateTestDataFiles()

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

overrideprotectedvirtual

Implements ExtensionGenerator.

References testDataDirName.

writeCFile()

void ViewerExtensionGenerator::writeCFile ( QString directory )

overrideprotectedvirtual

Implements ExtensionGenerator.

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

writeHFile()

void ViewerExtensionGenerator::writeHFile ( QString directory )

overrideprotectedvirtual

Implements ExtensionGenerator.

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

---

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

• ViewerExtensionGenerator.h
• ViewerExtensionGenerator.cpp