source: src/Actions/Process.hpp

Candidate_v1.6.1
Last change on this file was c09f94, checked in by Frederik Heber <heber@…>, 11 years ago

Transformed FragmentationAutomationAction into a Process.

  • Removed MaxSteps parameter in Process' cstor (MaxSteps is not a const member anyway).
  • Action preprocessor magic knows new token BASECLASS by which derivation may be switche from Action to Process (defaults to Action).
  • FragmentationAutomationAction::performCall() uses start(), stop(), and setMaxSteps().
  • Property mode set to 100644
File size: 2.3 KB
Line 
1/*
2 * Process.hpp
3 *
4 * Created on: Feb 17, 2010
5 * Author: crueger
6 */
7
8
9/**
10 * A Process is an action that might take some time and therfore contains methods
11 * that allows showing how much is done.
12 */
13#ifndef PROCESS_HPP_
14#define PROCESS_HPP_
15
16// include config.h
17#ifdef HAVE_CONFIG_H
18#include <config.h>
19#endif
20
21
22#include <set>
23
24#include "CodePatterns/Observer/Observable.hpp"
25#include "CodePatterns/Observer/Observer.hpp"
26#include "Actions/Action.hpp"
27
28namespace MoleCuilder {
29
30class ActionRegistry;
31
32/**
33 * A Process is an Action that might take some time and therefore has special
34 * methods to allow communication with progress indicators. Indicators
35 * can sign on at a global place and will be notified when any process is doing
36 * a calculation.
37 *
38 * A Process has four states:
39 * - starting: It is in the process of setting itself up, and wants everybody to know that it will start
40 * the calculation soon. Indicators should set up anything they need for displaying the progress
41 * when they are notified by a process in this state.
42 * - active: The process is currently doing it's thing and wants any indicator to know it's status, i.e.
43 * the percentage done.
44 * - stopping: The process has fullfilled it's purpose and is shutting down. Indicators recieving this status
45 * should also use it to shut down their indication mechanism and delete any objects allocated for
46 * this Process
47 * - inactive: This Process is currently sleeping. If a Process is sending out any signals in this state, there
48 * is something seriously wrong.
49 */
50class Process : public Action, public Observable
51{
52public:
53 Process(const ActionTrait &_trait);
54 virtual ~Process();
55
56 bool isRunning();
57 bool doesStart();
58 bool doesStop();
59 int getCurrStep() const;
60 void setCurrStep(int _currStep);
61 float getDoneRatio() const;
62 int getMaxSteps() const;
63 void setMaxSteps(int _maxSteps);
64
65protected:
66 void start();
67 void step();
68 void stop();
69
70private:
71 int currStep;
72 int maxSteps;
73 bool active;
74 bool starts;
75 bool stops;
76
77 // some global static stuff to allow general Observers that can show progresses
78public:
79 static void AddObserver(Observer *);
80 static void RemoveObserver(Observer *);
81private:
82 static std::set<Observer*> processObservers;
83};
84
85}
86
87#endif /* PROCESS_HPP_ */
Note: See TracBrowser for help on using the repository browser.