Changeset 57dd40 for src

Timestamp:

Apr 6, 2012, 11:44:09 AM (13 years ago)

Author:

Frederik Heber <heber@…>

Branches:

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

Children:

42b6de

Parents:

91be2d

git-author:

Frederik Heber <heber@…> (04/05/12 09:37:13)

git-committer:

Frederik Heber <heber@…> (04/06/12 11:44:09)

Message:

Extracted removal and adding of atoms from AtomicInfo to UndoRedoHelpers module.

• this way atoms can be quickly re-created, removed from AtomicInfo state information.
• added ResetAtomPosition().
• RemoveAction makes use of this.

Location:

src

Files:

• Actions/AtomAction/RemoveAction.cpp (modified) (3 diffs)
• Actions/Makefile.am (modified) (2 diffs)
• Actions/UndoRedoHelpers.cpp (added)
• Actions/UndoRedoHelpers.hpp (added)
• documentation/constructs/actions.dox (modified) (1 diff)

src/Actions/AtomAction/RemoveAction.cpp

@@ -20 +20 @@
 #include "CodePatterns/MemDebug.hpp"
 
+#include "Actions/UndoRedoHelpers.hpp"
 #include "Atom/atom.hpp"
 #include "Atom/AtomicInfo.hpp"
@@ -62 +63 @@
   AtomRemoveState *state = assert_cast<AtomRemoveState*>(_state.get());
 
-  size_t i=0;
-  for (; i<state->Walkers.size(); ++i) {
-    // re-create the atom
-    LOG(1, "Re-adding atom " << state->Walkers[i].getId() << ".");
-    atom *Walker = World::getInstance().createAtom();
-    if (!state->Walkers[i].setAtom(*Walker)) {
-      ELOG(1, "Failed to set id.");
-      World::getInstance().destroyAtom(Walker);
-      break;
-    }
-  }
-  if (i<state->Walkers.size()) {
-    // remove all previous ones, too
-    for (size_t j=0;j<i;++j)
-      World::getInstance().destroyAtom(state->Walkers[j].getId());
-    // and announce the failure of the undo
+  // add all removed atoms again
+  if (AddAtomsFromAtomicInfo(state->Walkers))
+    return Action::state_ptr(_state);
+  else
     return Action::failure;
-  }
-  return Action::state_ptr(_state);
 }
 
@@ -87 +74 @@
 
   // simple remove again all previously added atoms
-  for (size_t i=0; i<state->Walkers.size(); ++i) {
-    LOG(1, "Re-removing atom " << state->Walkers[i].getId() << ".");
-    World::getInstance().destroyAtom(state->Walkers[i].getId());
-  }
+  RemoveAtomsFromAtomicInfo(state->Walkers);
 
   return Action::state_ptr(_state);

src/Actions/Makefile.am

@@ -15 +15 @@
   Actions/OptionTrait.cpp \
   Actions/Process.cpp \
+  Actions/UndoRedoHelpers.cpp \
   Actions/Values.cpp \
   Actions/ValueStorage.cpp
@@ -45 +46 @@
   Actions/Reaction_impl_header.hpp \
   Actions/Reaction_impl_pre.hpp \
+  Actions/UndoRedoHelpers.hpp \
   Actions/Values.hpp \
   Actions/ValueStorage.hpp

src/documentation/constructs/actions.dox

@@ -47 +47 @@
  *    prototype.
  *
+ * \section actions-undo-redo Undoing and Redoing actions ...
  *
- *  \date 2011-10-31
+ * The central points of Actions is that they can be undone and redone. This
+ * has to be implemented in two more functions beside the "do".
+ *
+ * Note that undoing means to get every back to its original state and by whatever
+ * means seem appropriate, e.g. just remvoing all inserted atoms.
+ * To make this more elaborate it is usually very useful to store extra information
+ * in the Action's state such that undo and redo can be accomplished more quickly.
+ * E.g. if your Action creates some new atoms, store their info as \ref AtomicInfo.
+ * Then, undo can simply delete the newly created atoms and redo can quickly re-
+ * create them in the state they have been before.
+ *
+ * Have a look at \ref UndoRedoHelpers.hpp for some helper functions on this.
+ *
+ *
+ *  \date 2012-04-05
  *
  */