source: src/Actions/MakroAction.hpp@ 0f5956

Action_Thermostats Add_AtomRandomPerturbation Add_FitFragmentPartialChargesAction Add_RotateAroundBondAction Add_SelectAtomByNameAction Added_ParseSaveFragmentResults Adding_Graph_to_ChangeBondActions Adding_MD_integration_tests Adding_StructOpt_integration_tests Automaking_mpqc_open AutomationFragmentation_failures Candidate_v1.5.4 Candidate_v1.6.0 Candidate_v1.6.1 Candidate_v1.7.0 ChangeBugEmailaddress ChangingTestPorts ChemicalSpaceEvaluator 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_ChargeSampling_PBC Fix_ChronosMutex Fix_FitPartialCharges Fix_FitPotential_needs_atomicnumbers Fix_ForceAnnealing Fix_IndependentFragmentGrids Fix_ParseParticles Fix_ParseParticles_split_forward_backward_Actions 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 GeometryObjects Gui_displays_atomic_force_velocity IndependentFragmentGrids IndependentFragmentGrids_IndividualZeroInstances IndependentFragmentGrids_IntegrationTest IndependentFragmentGrids_Sole_NN_Calculation JobMarket_RobustOnKillsSegFaults JobMarket_StableWorkerPool JobMarket_unresolvable_hostname_fix ODR_violation_mpqc_open PartialCharges_OrthogonalSummation PythonUI_with_named_parameters QtGui_reactivate_TimeChanged_changes Recreated_GuiChecks RotateToPrincipalAxisSystem_UndoRedo SaturateAtoms_findBestMatching SaturateAtoms_singleDegree StoppableMakroAction Subpackage_CodePatterns Subpackage_JobMarket Subpackage_LinearAlgebra Subpackage_levmar Subpackage_mpqc_open Subpackage_vmg ThirdParty_MPQC_rebuilt_buildsystem TrajectoryDependenant_MaxOrder TremoloParser_IncreasedPrecision TremoloParser_MultipleTimesteps Ubuntu_1604_changes stable
Last change on this file since 0f5956 was 10aee4, checked in by Frederik Heber <heber@…>, 10 years ago

Cleaned up ActionQueue's interface: Actions are always cloned.

  • Action's dstor needs to be public as we have a clone() function.
  • ActionRegistrys' (and AQ's) getActionByName now returns const ref. We must not return a ptr as it may not get deleted elsewhere. We are handing out prototypes.
  • queueAction(action*,...) is private to prevent leakage, queueAction(string, ...) is the public interface.
  • some other small functions are now private, too.
  • MakroActions now need to clone() the prototype on prepare() and delete them on unprepare().
  • ActionSequence deletes contained actions.
  • FIX: ActionSequenceUnitTest cannot check on not-called property of removed actions anymore as these are gone now (they are deleted on removal and they are cloned on insertion).
  • DOCU: Updated documentation on Actions.
  • Property mode set to 100644
File size: 2.5 KB
Line 
1/*
2 * MakroAction.hpp
3 *
4 * Created on: Dec 17, 2009
5 * Author: crueger
6 */
7
8#ifndef MAKROACTION_HPP_
9#define MAKROACTION_HPP_
10
11// include config.h
12#ifdef HAVE_CONFIG_H
13#include <config.h>
14#endif
15
16
17#include <string>
18
19#include "Actions/Action.hpp"
20#include "Actions/ActionSequence.hpp"
21
22class ActionSequenceTest;
23
24namespace MoleCuilder {
25 class ActionRegistry;
26
27/**
28 * Action to allow producing bigger Actions from sequences of small actions.
29 *
30 * Destruction of the Actions and the sequence is handled by this class.
31 */
32class MakroAction : public Action
33{
34 //!> grant unit test access to sequence
35 friend class ::ActionSequenceTest;
36public:
37 MakroAction(const MakroAction &_instance);
38 MakroAction(const ActionTrait &_trait,ActionSequence& _actions);
39
40 bool canUndo();
41 bool shouldUndo();
42
43 virtual Action* clone(enum QueryOptions flag = Interactive) const;
44 void prepare(enum QueryOptions flag = Interactive);
45
46 virtual void outputAsCLI(std::ostream &ost) const;
47 virtual void outputAsPython(std::ostream &ost, const std::string &prefix) const;
48
49 virtual void setOptionValue(const std::string &_token, const std::string &_value);
50
51 // must be called after all primitive actions are present
52 virtual void prepare(ActionRegistry &AR);
53 // must be called before alle primitive actions are removed
54 virtual void unprepare(ActionRegistry &AR);
55
56protected:
57 virtual ~MakroAction();
58
59 /**
60 * MakroAction requires an own dialog for global options such as number of loop
61 * iterations, ... besides the dialog from each action in the sequence.
62 *
63 * However, fillDialog() calls ActionSequence::fillAllDialog(). Hence, the dialog
64 * for specific global options must be requested in an distinct function.
65 */
66 virtual Dialog * fillOwnDialog(Dialog*);
67
68 /** Pass-thru for removeAction to allow all derived MakroActions to manipulate action sequence.
69 *
70 * \param name name of action to remove
71 * \return true - action removed, false - action not found
72 * \sa ActionSequence::removeAction()
73 */
74 bool removeAction(const std::string &name);
75
76 virtual ActionState::ptr performCall();
77 virtual ActionState::ptr performUndo(ActionState::ptr);
78 virtual ActionState::ptr performRedo(ActionState::ptr);
79
80 void setLoop(unsigned int _loop);
81
82private:
83 /** fillDialog is used to spawn sequence queries, hence must not be modified by
84 * derived MakroActions.
85 */
86 Dialog *fillDialog(Dialog *dialog);
87
88 //!> this points to the instance of a specific MakroAction, we need to ref for callAll()
89 ActionSequence &actions;
90};
91
92}
93
94#endif /* MAKROACTION_HPP_ */
Note: See TracBrowser for help on using the repository browser.