MorphoGraphX
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Namespaces | Macros | Typedefs | Functions
Process.hpp File Reference

File containing the definition of a Process. More...

#include <Config.hpp>
#include <GL.hpp>
#include <Clip.hpp>
#include <CuttingSurface.hpp>
#include <Forall.hpp>
#include <Information.hpp>
#include <Mesh.hpp>
#include <Stack.hpp>
#include <Store.hpp>
#include <Vector.hpp>
#include <algorithm>
#include <iostream>
#include <QIcon>
#include <QSharedPointer>
#include <QStringList>
#include <QTextStream>
#include <typeinfo>

Go to the source code of this file.

Classes

class  mgx::process::UserCancelException
 Exception launched when a user clicks the Cancel button. More...
 
class  mgx::process::Process
 This is the main process class, the one all process inherit from. More...
 
class  mgx::process::Process::CheckState
 Class that construct a state check on the current process. More...
 
struct  mgx::process::Process::CheckState::ProcessReqs
 
class  mgx::process::StackProcess
 Stack processes have non-mutable access to meshes and mutable access to stacks. More...
 
class  mgx::process::MeshProcess
 Mesh processes have mutable access to meshes and non-mutable access to stacks. More...
 
class  mgx::process::GlobalProcess
 Global processes have full mutable access to all properties of the process. More...
 
struct  mgx::process::BaseProcessDefinition
 Definition of a process, without the process factory. More...
 
class  mgx::process::ProcessDefinition< P >
 Definition of a process, including the process factory. More...
 

Namespaces

 mgx
 This namespace contains all the API of MorphoGraphX.
 
 process
 This namespace contains all the classes needed to define processes.
 

Macros

#define PROCESS_VERSION
 Number identifying the running version of the process API. More...
 
#define REGISTER_STACK_PROCESS(ClassName)
 Register ClassName has a stack process. More...
 
#define REGISTER_MESH_PROCESS(ClassName)
 Register ClassName has a mesh process. More...
 
#define REGISTER_GLOBAL_PROCESS(ClassName)
 Register ClassName has a global process. More...
 

Typedefs

typedef QHash< int, QStringListmgx::process::ParmChoiceMap
 Type of the dictionary giving the list of possible strings for each argument. More...
 

Functions

mgx_EXPORT BaseProcessDefinition * mgx::process::getBaseProcessDefinition (const QString &processType, const QString &processName)
 Retrieves the process definition from the type and name of the process. More...
 
mgx_EXPORT bool mgx::process::getLastParms (const Process &proc, QStringList &parms)
 Get the parameters for a given process.
 
mgx_EXPORT bool mgx::process::getDefaultParms (const Process &proc, QStringList &parms)
 Get the default parameters for a given process (i.e. the ones defined by the process)
 
mgx_EXPORT bool mgx::process::saveDefaultParms (const Process &proc, const QStringList &parms)
 Save the default parameters in memory.
 
mgx_EXPORT bool mgx::process::checkProcessParms (const Process &proc, const QStringList &parms, size_t *nbParms=0)
 Check if the parameters have enough defaults.
 
mgx_EXPORT bool mgx::process::getLastParms (const QString &processType, const QString &processName, QStringList &parms)
 Get the parameters for a given process.
 
mgx_EXPORT bool mgx::process::getDefaultParms (const QString &processType, const QString &processName, QStringList &parms)
 Get the default parameters for a given process (i.e. the ones defined by the process)
 
mgx_EXPORT bool mgx::process::saveDefaultParms (const QString &processType, const QString &processName, const QStringList &parms)
 Save the default parameters in memory.
 
mgx_EXPORT bool mgx::process::checkProcessParms (const QString &processType, const QString &processName, const QStringList &parms, size_t *nbParms=0)
 Check if the parameters have enough defaults.
 
mgx_EXPORT QStringList mgx::process::listProcesses (const QString &processType)
 Returns the list of names of the processes of a given type.
 
mgx_EXPORT bool mgx::process::validProcessType (const QString &processType)
 Check if processType is a valid type (i.e. More...
 
mgx_EXPORT bool mgx::process::validProcessName (const QString &processType, const QString &processName)
 Check if the processName exist in the list of processType.
 
mgx_EXPORT bool mgx::process::stringToBool (const QString &string)
 Helper function converting a string into a boolean.
 
mgx_EXPORT bool mgx::process::stringToWorkStore (const QString &string)
 Returns true if string correspond to the work store, false otherwise.
 
mgx_EXPORT bool mgx::process::stringToMainStore (const QString &string)
 Returns true if string correspond to the main store, false otherwise.
 
QString mgx::process::boolToString (bool b)
 Helper function converting a boolean into a string.
 

Detailed Description

File containing the definition of a Process.

Macro Definition Documentation

#define PROCESS_VERSION

Number identifying the running version of the process API.

This makes sure the loaded processes will run with the current API. Otherwise, an error informing correctly the user will be shown in the standard error.

This is set to the SVN revision number that triggered a change in the process interface