source: src/Actions/MakroAction.cpp@ d93d2c

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 d93d2c was 10aee4, checked in by Frederik Heber <heber@…>, 9 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: 4.3 KB
RevLine 
[bcf653]1/*
2 * Project: MoleCuilder
3 * Description: creates and alters molecular systems
[0aa122]4 * Copyright (C) 2010-2012 University of Bonn. All rights reserved.
[5aaa43]5 * Copyright (C) 2013 Frederik Heber. All rights reserved.
[94d5ac6]6 *
7 *
8 * This file is part of MoleCuilder.
9 *
10 * MoleCuilder is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * MoleCuilder is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with MoleCuilder. If not, see <http://www.gnu.org/licenses/>.
[bcf653]22 */
23
[1fa107]24/*
25 * MakroAction.cpp
26 *
27 * Created on: Dec 17, 2009
28 * Author: crueger
29 */
30
[bf3817]31// include config.h
32#ifdef HAVE_CONFIG_H
33#include <config.h>
34#endif
35
[ad011c]36#include "CodePatterns/MemDebug.hpp"
[112b09]37
[cc04b7]38#include <string>
39
[1fa107]40#include "Actions/MakroAction.hpp"
41#include "Actions/Action.hpp"
[9c1324]42#include "Actions/ActionExceptions.hpp"
[0c8056]43#include "Actions/ActionRegistry.hpp"
[1fa107]44#include "Actions/ActionSequence.hpp"
[ad011c]45#include "CodePatterns/Assert.hpp"
[9c1324]46#include "UIElements/Dialog.hpp"
47#include "UIElements/UIFactory.hpp"
[1fa107]48
[ce7fdc]49using namespace MoleCuilder;
[cc04b7]50
[67e2b3]51class MakroActionState : public ActionState{
52public:
53 MakroActionState(ActionSequence::stateSet _states) :
54 states(_states)
55 {}
56 virtual ~MakroActionState(){
[5b0b98]57 // All contained states are destroyed by the shared ptrs
[67e2b3]58 }
59
60 ActionSequence::stateSet states;
61};
62
[329cf3]63MakroAction::MakroAction(const MakroAction &_instance) :
64 Action(_instance.Traits),
65 actions(_instance.actions)
66{}
67
[126867]68MakroAction::MakroAction(const ActionTrait &_trait,ActionSequence& _actions) :
69 Action(_trait),
70 actions(_actions)
[1fa107]71{
72}
73
74MakroAction::~MakroAction()
75{
[10aee4]76 // emptying the sequence is done in ActionSequence
[1fa107]77}
78
[22b786]79void MakroAction::prepare(ActionRegistry &AR)
80{}
81
82void MakroAction::unprepare(ActionRegistry &AR)
83{}
84
[9c1324]85void MakroAction::setLoop(unsigned int _loop)
86{
87 actions.setLoop(_loop);
88}
89
[237f93]90bool MakroAction::removeAction(const std::string &name)
91{
[74459a]92 return actions.removeAction(name);
[237f93]93}
94
95Dialog* MakroAction::fillOwnDialog(Dialog *dialog) {
96 return dialog;
97}
98
[047878]99Dialog* MakroAction::fillDialog(Dialog *dialog) {
[237f93]100 dialog = fillOwnDialog(dialog);
[22b786]101 return actions.fillAllDialogs(dialog);
[80951de]102}
[1fa107]103
[b5b01e]104ActionState::ptr MakroAction::performCall(){
[22b786]105 ActionSequence::stateSet states = actions.callAll(true);
[b5b01e]106 return ActionState::ptr(new MakroActionState(states));
[1fa107]107}
108
[b5b01e]109ActionState::ptr MakroAction::performUndo(ActionState::ptr _state) {
[5b0b98]110 MakroActionState *state = dynamic_cast<MakroActionState*>(_state.get());
[67e2b3]111 ASSERT(state,"Type mismatch for the state of the MakroAction");
[22b786]112 ActionSequence::stateSet states = actions.undoAll(state->states);
[b5b01e]113 return ActionState::ptr(new MakroActionState(states));
[5b0b98]114}
115
[b5b01e]116ActionState::ptr MakroAction::performRedo(ActionState::ptr _state){
[5b0b98]117 MakroActionState *state = dynamic_cast<MakroActionState*>(_state.get());
118 ASSERT(state,"Type mismatch for the state of the MakroAction");
[22b786]119 ActionSequence::stateSet states = actions.redoAll(state->states);
[b5b01e]120 return ActionState::ptr(new MakroActionState(states));
[1fa107]121}
122
123bool MakroAction::canUndo() {
[22b786]124 return actions.canUndo();
[1fa107]125}
[67e2b3]126
127bool MakroAction::shouldUndo() {
[22b786]128 return actions.shouldUndo();
[67e2b3]129}
[46b181]130
[af5384]131Action* MakroAction::clone(enum QueryOptions flag) const
132{
133 if (flag == Interactive)
134 return new MakroAction(Traits, actions);
135 else
136 return new MakroAction(*this);
137}
138
139void MakroAction::prepare(enum QueryOptions flag)
140{
141 if (flag == Interactive) {
142 // create and run our dialog and also of all members of the sequence
143 Dialog* dialog = createDialog();
144 if (dialog->hasQueries()) {
145 if (!dialog->display())
146 // dialog error or aborted -> throw exception
147 throw ActionFailureException() << ActionNameString(getName());
148 }
149 delete(dialog);
150 }
151}
152
[46b181]153void MakroAction::outputAsCLI(std::ostream &ost) const
154{
155 actions.outputAsCLI(ost);
156}
[477012]157
158void MakroAction::outputAsPython(std::ostream &ost, const std::string &prefix) const
159{
[992839]160 actions.outputAsPython(ost, prefix);
[477012]161}
[a82f61]162
163void MakroAction::setOptionValue(const std::string &_token, const std::string &_value)
164{
165 actions.setOptionValue(_token, _value);
166}
Note: See TracBrowser for help on using the repository browser.