Kactus2
Kactus2 reference guide
Loading...
Searching...
No Matches
Public Member Functions | List of all members
CLIGenerator Class Referenceabstract

Interface for enabling plugin run using the command line arguments. More...

#include <CLIGenerator.h>

Public Member Functions

virtual ~CLIGenerator ()
 The destructor.
 
virtual QString getOutputFormat () const =0
 
virtual void runGenerator (IPluginUtility *utility, QSharedPointer< Component > component, QSharedPointer< Design > design, QSharedPointer< DesignConfiguration > designConfiguration, QString const &viewName, QString const &outputDirectory)=0
 

Detailed Description

Interface for enabling plugin run using the command line arguments.

Definition at line 28 of file CLIGenerator.h.

Constructor & Destructor Documentation

◆ ~CLIGenerator()

virtual CLIGenerator::~CLIGenerator ( )
inlinevirtual

The destructor.

Definition at line 33 of file CLIGenerator.h.

Member Function Documentation

◆ getOutputFormat()

virtual QString CLIGenerator::getOutputFormat ( ) const
pure virtual

Gets the output format generated by the plugin.

Returns
The output file format generated by the plugin.

◆ runGenerator()

virtual void CLIGenerator::runGenerator ( IPluginUtility * utility,
QSharedPointer< Component > component,
QSharedPointer< Design > design,
QSharedPointer< DesignConfiguration > designConfiguration,
QString const & viewName,
QString const & outputDirectory )
pure virtual

Runs the generation.

Parameters
[in]utilityUtilities for enabling plugin execution.
[in]componentThe component to run the generation for.
[in]designThe design to run the generation for.
[in]designConfigurationThe design configuration to run the generation for.
[in]viewNameThe component view name to run the generation for.
[in]outputDirectoryThe output directory for the generation results.
The documentation for this class was generated from the following file: