scaffold  1.0.0
Generates files and directories based on templates and user input
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
scaffold::Project Class Reference

A project as represented by the program. More...

#include <project.h>

+ Inheritance diagram for scaffold::Project:

Public Member Functions

 Project (const QString &s_name)
 constructor
 
virtual ~Project (void)
 destructor;
 
bool generate (void)
 generate the project; called at the end
 
Variables exposed

Simply places a comercial envelope on normal variable management

QString name (void) const
 the name
 
QString unixName (void) const
 the name in unix format
 
QString description (void) const
 the description
 
QString outPath (void) const
 output path
 
Generators

Includes management of the generators belonging to a project

void addGenerator (Generator *g)
 an a generator
 
Generatorgenerator (const QString &s_name)
 get generator by name
 
Generatorgenerator (void)
 get current generator
 
void setGenerator (Generator *g)
 set current generator
 

Detailed Description

A project as represented by the program.

On each run the program may manage any number of projects like this one. Scaffold class contains a list of instances of this class.

Any project has a name and a destination directory. At creation time a list of variables are set to represent these values.

The project contains a list of generators; their names is also stored when the generator is inserted in PRJ::GENERATORS variable. Current generator is returned by generator(); GEN command uses addGenerator() to insert a new generator in current project.


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