source: src/Actions/ActionQueue.hpp@ c5177f

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 c5177f was 05c989, checked in by Frederik Heber <heber@…>, 12 years ago

Actions are now called through ActionQueue.

  • Action::call() is protected.
  • ActionQueue has queueAction().
  • Property mode set to 100644
File size: 2.8 KB
RevLine 
[628577]1/*
2 * ActionQueue.hpp
3 *
4 * Created on: Aug 16, 2013
5 * Author: heber
6 */
7
8#ifndef ACTIONQUEUE_HPP_
9#define ACTIONQUEUE_HPP_
10
11// include config.h
12#ifdef HAVE_CONFIG_H
13#include <config.h>
14#endif
15
16#include "CodePatterns/Singleton.hpp"
17
[1d3563]18#include <list>
[690741]19#include <vector>
[1d3563]20
[b5b01e]21#include "Actions/ActionState.hpp"
[628577]22
23namespace MoleCuilder {
24
25class Action;
[6367dd]26class ActionHistory;
[ed3944]27class ActionRegistry;
28class ActionTrait;
[628577]29
30/** This class combines the whole handling of Actions into a single class.
31 *
[1d3563]32 * It spawns new Actions by its internal ActionRegistry. Spawned Actions are
33 * automatically queued and placed into a History after execution.
[628577]34 */
35class ActionQueue : public Singleton<ActionQueue>
36{
37 friend class Singleton<ActionQueue>;
38public:
[690741]39 typedef std::vector<std::string> ActionTokens_t;
[1d3563]40 typedef std::list<Action *> ActionQueue_t;
41
[05c989]42 /** Queues the Action with \a name to be called.
43 *
44 */
45 void queueAction(const std::string &name);
46
[1d3563]47 /** Returns the spawned action by token \a name.
48 *
49 * Action is checked into internal queue.
50 *
51 * \return pointer to newly spawned action
52 */
[a6ceab]53 Action* getActionByName(const std::string &name);
[1d3563]54
55 /** Checks whether the Action is known by the given \a name.
56 *
57 * \param name token of action to check
58 * \return true - token is known, false - else
59 */
[a6ceab]60 bool isActionKnownByName(const std::string &name) const;
[1d3563]61
[126867]62 /** Register an Action with the ActionRegistry.
63 *
64 * \param _action action to add
65 */
66 void registerAction(Action *_action);
67
[690741]68 /** Returns the vector with the tokens of all currently known Actions.
69 *
70 * \return list of all tokens
71 */
72 const ActionTokens_t getListOfActions() const;
73
74 /** Returns the trait to an Action.
75 *
76 * \param name name of Action
77 * \return const ref to its default Trait.
78 */
[a6ceab]79 const ActionTrait& getActionsTrait(const std::string &name) const;
[690741]80
[6367dd]81 /** Undoes last called Action.
82 *
83 */
84 void undoLast();
85
86 /** Redoes last undone Action.
87 *
88 */
89 void redoLast();
90
91private:
92 //!> grant Action access to internal history functions.
93 friend class Action;
94
95 /** Wrapper function to add state to ActionHistory.
96 *
97 * \param _Action Action whose state to add
98 * \param _state state to add
99 */
100 void addElement(Action* _Action, ActionState::ptr _state);
101
102 /** Wrapper function to clear ActionHistory.
103 *
104 */
105 void clear();
106
[628577]107private:
[1d3563]108 /** Private cstor for ActionQueue.
109 *
110 * Must be private as is singleton.
111 *
112 */
[628577]113 ActionQueue();
[1d3563]114
115 /** Dstor for ActionQueue.
116 *
117 */
[628577]118 ~ActionQueue();
119
120 //!> ActionRegistry to spawn new actions
[ed3944]121 ActionRegistry *AR;
[1d3563]122
[6367dd]123 //!> ActionHistory is for undoing and redoing actions, requires ActionRegistry fully initialized
124 ActionHistory *history;
125
[1d3563]126 //!> internal queue of actions
127 ActionQueue_t queue;
[628577]128};
129
130};
131
132#endif /* ACTIONQUEUE_HPP_ */
Note: See TracBrowser for help on using the repository browser.