source: src/Actions/MakroAction.hpp@ 94232b

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 94232b was a82f61, checked in by Frederik Heber <heber@…>, 9 years ago

Added Action::setOptionValue() which allows setting the option via a string.

  • this is preparatory for allowing the creation of MakroActions inside the code. We need to set the options without going through dialogs in some way or another and without being completely inside the Actions as is the case for the COMMAND variants and the python function calls.
  • 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 virtual ~MakroAction();
40
41 bool canUndo();
42 bool shouldUndo();
43
44 virtual Action* clone(enum QueryOptions flag = Interactive) const;
45 void prepare(enum QueryOptions flag = Interactive);
46
47 virtual void outputAsCLI(std::ostream &ost) const;
48 virtual void outputAsPython(std::ostream &ost, const std::string &prefix) const;
49
50 virtual void setOptionValue(const std::string &_token, const std::string &_value);
51
52 // must be called after all primitive actions are present
53 virtual void prepare(ActionRegistry &AR);
54 // must be called before alle primitive actions are removed
55 virtual void unprepare(ActionRegistry &AR);
56
57protected:
58 /**
59 * MakroAction requires an own dialog for global options such as number of loop
60 * iterations, ... besides the dialog from each action in the sequence.
61 *
62 * However, fillDialog() calls ActionSequence::fillAllDialog(). Hence, the dialog
63 * for specific global options must be requested in an distinct function.
64 */
65 virtual Dialog * fillOwnDialog(Dialog*);
66
67 /** Pass-thru for removeAction to allow all derived MakroActions to manipulate action sequence.
68 *
69 * \param name name of action to remove
70 * \return true - action removed, false - action not found
71 * \sa ActionSequence::removeAction()
72 */
73 bool removeAction(const std::string &name);
74
75 virtual ActionState::ptr performCall();
76 virtual ActionState::ptr performUndo(ActionState::ptr);
77 virtual ActionState::ptr performRedo(ActionState::ptr);
78
79 void setLoop(unsigned int _loop);
80
81private:
82 /** fillDialog is used to spawn sequence queries, hence must not be modified by
83 * derived MakroActions.
84 */
85 Dialog *fillDialog(Dialog *dialog);
86
87 //!> this points to the instance of a specific MakroAction, we need to ref for callAll()
88 ActionSequence &actions;
89};
90
91}
92
93#endif /* MAKROACTION_HPP_ */
Note: See TracBrowser for help on using the repository browser.