Public Slots | Signals | Public Member Functions | List of all members
ARCSProcess Class Reference

This class is representing a process under ARCS. More...

#include <arcsprocess.h>

Inheritance diagram for ARCSProcess:
Inheritance graph
Collaboration diagram for ARCSProcess:
Collaboration graph

Public Slots

void changeSheet (QString s)
 
void finish ()
 

Signals

void finished ()
 

Public Member Functions

void setContext (ARCSContext *ctx)
 
bool setController (QString s=QString::null)
 
void addSheet (QString s, ARCSSheet sh)
 
void removeSheet (QString s)
 
void renameSheet (QString oldName, QString newName)
 
ARCSSheetgetSheet (QString s)
 
QStringList getSheetNames ()
 
QString getControllerId ()
 
void setApplicationMode (ARCS::ARCSAppFlag flag)
 
void setReferenceApplicationMode (ARCS::ARCSAppFlag flag)
 
bool startProcess ()
 
bool stopProcess ()
 
virtual bool event (QEvent *event)
 
void waitForFirstSheet ()
 
ARCSControllerComponentgetController ()
 
ARCSContextgetContext ()
 
bool hasFinished ()
 
void setupNextSheet ()
 
void wait ()
 

Detailed Description

This class is representing a process under ARCS.

A process manages a set of sheets using a controller.

Author
Jean-Yves Didier
Date
April, the 5th, 2009

Definition at line 52 of file arcsprocess.h.

Member Function Documentation

void ARCSProcess::addSheet ( QString  s,
ARCSSheet  sh 
)

Adds a sheet to the process

Parameters
sthe name of the sheet
shthe actual sheet structure

Definition at line 209 of file arcsprocess.cpp.

Here is the caller graph for this function:

void ARCSProcess::changeSheet ( QString  s)
slot

Changes the current sheet This is usually triggered by the controller. The current sheet is deactivated and setupNextSheet() is eventually triggered.

Parameters
sthe name of the new sheet.

Definition at line 75 of file arcsprocess.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool ARCSProcess::event ( QEvent *  event)
virtual

An event handler inherited from QObject The purpose is to handle events when the process has an event loop. This is usually triggered by the ARCSAppMode::tokenHook() if needed.

Definition at line 62 of file arcsprocess.cpp.

Here is the call graph for this function:

void ARCSProcess::finish ( )
slot

Trigger this slot to finish the process (for internal use only)

Definition at line 112 of file arcsprocess.cpp.

Here is the caller graph for this function:

void ARCSProcess::finished ( )
signal

Triggered when the process is finished

Here is the caller graph for this function:

ARCSContext* ARCSProcess::getContext ( )
inline

Returns the context to which this process is linked

Definition at line 138 of file arcsprocess.h.

Here is the caller graph for this function:

ARCSControllerComponent* ARCSProcess::getController ( )
inline

Returns the actual controller component

Definition at line 135 of file arcsprocess.h.

Here is the caller graph for this function:

QString ARCSProcess::getControllerId ( )
inline

Returns the id of the controller

Definition at line 96 of file arcsprocess.h.

Here is the caller graph for this function:

ARCSSheet& ARCSProcess::getSheet ( QString  s)
inline

Returns the sheet with the given name

Parameters
sthe name of the sheet to return
Returns
a sheet structure

Definition at line 86 of file arcsprocess.h.

QStringList ARCSProcess::getSheetNames ( )
inline

Returns the list of the sheets stored inside the process

Definition at line 94 of file arcsprocess.h.

Here is the caller graph for this function:

bool ARCSProcess::hasFinished ( )
inline

Tells wether the process has finished its task or not (not thread-reentrant)

Definition at line 141 of file arcsprocess.h.

void ARCSProcess::removeSheet ( QString  s)

Removes a sheet from the sheet list of the process

Parameters
sthe name of the sheet to remove

Definition at line 260 of file arcsprocess.cpp.

void ARCSProcess::renameSheet ( QString  oldName,
QString  newName 
)

Renames a sheet in the process list This function will do nothing if newName is already taken by another sheet.

Parameters
oldNameold sheet name
newNamenew sheet name

Definition at line 248 of file arcsprocess.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void ARCSProcess::setApplicationMode ( ARCS::ARCSAppFlag  flag)
inline

Sets the application mode of the process This method is intended to be used with the main process of the application. For other process, you should use setReferenceApplicationMode()

Parameters
flagthe application mode flag to use.
See also
setReferenceApplicationMode()

Definition at line 109 of file arcsprocess.h.

void ARCSProcess::setContext ( ARCSContext ctx)
inline

Links this process with the context of the application

Definition at line 61 of file arcsprocess.h.

Here is the caller graph for this function:

bool ARCSProcess::setController ( QString  s = QString::null)

Sets the controller to use with this process

Definition at line 120 of file arcsprocess.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void ARCSProcess::setReferenceApplicationMode ( ARCS::ARCSAppFlag  flag)

Sets the reference application mode the process Use this method when the process is not the main process of the application. This method will then compute the resulting application mode for this process i.e. if it is a basic thread or a thread with an event loop.

Parameters
flagthe reference application mode flag to use

Definition at line 52 of file arcsprocess.cpp.

void ARCSProcess::setupNextSheet ( )

Sets up the next sheet

Definition at line 216 of file arcsprocess.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool ARCSProcess::startProcess ( )

starts the process

Definition at line 173 of file arcsprocess.cpp.

Here is the call graph for this function:

bool ARCSProcess::stopProcess ( )

stops the process (not implemented yet)

Definition at line 192 of file arcsprocess.cpp.

void ARCSProcess::wait ( )

Waits for the end of this process

Definition at line 232 of file arcsprocess.cpp.

void ARCSProcess::waitForFirstSheet ( )

Waits for the first sheet of the process to be set up This method is needed because subprocesses must be initialized before the main process starts.

Definition at line 201 of file arcsprocess.cpp.


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