Action_Thermostats
Add_AtomRandomPerturbation
Add_FitFragmentPartialChargesAction
Add_RotateAroundBondAction
Add_SelectAtomByNameAction
Added_ParseSaveFragmentResults
AddingActions_SaveParseParticleParameters
Adding_Graph_to_ChangeBondActions
Adding_MD_integration_tests
Adding_ParticleName_to_Atom
Adding_StructOpt_integration_tests
AtomFragments
Automaking_mpqc_open
AutomationFragmentation_failures
Candidate_v1.5.4
Candidate_v1.6.0
Candidate_v1.6.1
ChangeBugEmailaddress
ChangingTestPorts
ChemicalSpaceEvaluator
CombiningParticlePotentialParsing
Combining_Subpackages
Debian_Package_split
Debian_package_split_molecuildergui_only
Disabling_MemDebug
Docu_Python_wait
EmpiricalPotential_contain_HomologyGraph
EmpiricalPotential_contain_HomologyGraph_documentation
Enable_parallel_make_install
Enhance_userguide
Enhanced_StructuralOptimization
Enhanced_StructuralOptimization_continued
Example_ManyWaysToTranslateAtom
Exclude_Hydrogens_annealWithBondGraph
FitPartialCharges_GlobalError
Fix_BoundInBox_CenterInBox_MoleculeActions
Fix_ChargeSampling_PBC
Fix_ChronosMutex
Fix_FitPartialCharges
Fix_FitPotential_needs_atomicnumbers
Fix_ForceAnnealing
Fix_IndependentFragmentGrids
Fix_ParseParticles
Fix_ParseParticles_split_forward_backward_Actions
Fix_PopActions
Fix_QtFragmentList_sorted_selection
Fix_Restrictedkeyset_FragmentMolecule
Fix_StatusMsg
Fix_StepWorldTime_single_argument
Fix_Verbose_Codepatterns
Fix_fitting_potentials
Fixes
ForceAnnealing_goodresults
ForceAnnealing_oldresults
ForceAnnealing_tocheck
ForceAnnealing_with_BondGraph
ForceAnnealing_with_BondGraph_continued
ForceAnnealing_with_BondGraph_continued_betteresults
ForceAnnealing_with_BondGraph_contraction-expansion
FragmentAction_writes_AtomFragments
FragmentMolecule_checks_bonddegrees
GeometryObjects
Gui_Fixes
Gui_displays_atomic_force_velocity
ImplicitCharges
IndependentFragmentGrids
IndependentFragmentGrids_IndividualZeroInstances
IndependentFragmentGrids_IntegrationTest
IndependentFragmentGrids_Sole_NN_Calculation
JobMarket_RobustOnKillsSegFaults
JobMarket_StableWorkerPool
JobMarket_unresolvable_hostname_fix
MoreRobust_FragmentAutomation
ODR_violation_mpqc_open
PartialCharges_OrthogonalSummation
PdbParser_setsAtomName
PythonUI_with_named_parameters
QtGui_reactivate_TimeChanged_changes
Recreated_GuiChecks
Rewrite_FitPartialCharges
RotateToPrincipalAxisSystem_UndoRedo
SaturateAtoms_findBestMatching
SaturateAtoms_singleDegree
StoppableMakroAction
Subpackage_CodePatterns
Subpackage_JobMarket
Subpackage_LinearAlgebra
Subpackage_levmar
Subpackage_mpqc_open
Subpackage_vmg
Switchable_LogView
ThirdParty_MPQC_rebuilt_buildsystem
TrajectoryDependenant_MaxOrder
TremoloParser_IncreasedPrecision
TremoloParser_MultipleTimesteps
TremoloParser_setsAtomName
Ubuntu_1604_changes
stable
Last change
on this file since 23359f was 2efa90, checked in by Tillmann Crueger <crueger@…>, 15 years ago |
Added detailed documentation for the Action class
|
-
Property mode
set to
100644
|
File size:
2.2 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 <set>
|
---|
17 |
|
---|
18 | #include "Patterns/Observer.hpp"
|
---|
19 | #include "Actions/Action.hpp"
|
---|
20 |
|
---|
21 | /**
|
---|
22 | * A Process is an Action that might take some time and therefore has special
|
---|
23 | * methods to allow communication with progress indicators. Indicators
|
---|
24 | * can sign on at a global place and will be notified when any process is doing
|
---|
25 | * a calculation.
|
---|
26 | *
|
---|
27 | * A Process has four states:
|
---|
28 | * - starting: It is in the process of setting itself up, and wants everybody to know that it will start
|
---|
29 | * the calculation soon. Indicators should set up anything they need for displaying the progress
|
---|
30 | * when they are notified by a process in this state.
|
---|
31 | * - active: The process is currently doing it's thing and wants any indicator to know it's status, i.e.
|
---|
32 | * the percentage done.
|
---|
33 | * - stopping: The process has fullfilled it's purpose and is shutting down. Indicators recieving this status
|
---|
34 | * should also use it to shut down their indication mechanism and delete any objects allocated for
|
---|
35 | * this Process
|
---|
36 | * - inactive: This Process is currently sleeping. If a Process is sending out any signals in this state, there
|
---|
37 | * is something seriously wrong.
|
---|
38 | */
|
---|
39 | class Process : public Action, public Observable
|
---|
40 | {
|
---|
41 | public:
|
---|
42 | Process(int _maxSteps, std::string _name, bool _doRegister=true);
|
---|
43 | virtual ~Process();
|
---|
44 |
|
---|
45 | bool isRunning();
|
---|
46 | bool doesStart();
|
---|
47 | bool doesStop();
|
---|
48 | int getCurrStep();
|
---|
49 | void setCurrStep(int _currStep);
|
---|
50 | float getDoneRatio();
|
---|
51 | int getMaxSteps();
|
---|
52 | void setMaxSteps(int _maxSteps);
|
---|
53 |
|
---|
54 | protected:
|
---|
55 | void start();
|
---|
56 | void step();
|
---|
57 | void stop();
|
---|
58 |
|
---|
59 | private:
|
---|
60 | int currStep;
|
---|
61 | int maxSteps;
|
---|
62 | bool active;
|
---|
63 | bool starts;
|
---|
64 | bool stops;
|
---|
65 |
|
---|
66 | // some global static stuff to allow general Observers that can show progresses
|
---|
67 | public:
|
---|
68 | static void AddObserver(Observer *);
|
---|
69 | static void RemoveObserver(Observer *);
|
---|
70 | private:
|
---|
71 | static std::set<Observer*> processObservers;
|
---|
72 | };
|
---|
73 |
|
---|
74 | #endif /* PROCESS_HPP_ */
|
---|
Note:
See
TracBrowser
for help on using the repository browser.