Changeset af5384 for src

Timestamp:

Apr 29, 2014, 12:42:44 PM (11 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:

7fc447

Parents:

36053c

git-author:

Frederik Heber <heber@…> (08/27/13 01:58:34)

git-committer:

Frederik Heber <heber@…> (04/29/14 12:42:44)

Message:

Actions can now clone() and split off prepare() from call().

• ActionQueue now separates call phase into clone(), prepare(), and call().
• ActionQueue's dstor releases Actions in deque.
• CurrentAction is an index as push_back always invalidates iterator.
• ActionQueue_t is now a simple vector of ptrs.
• call() is now non-interactive, (maybe) interactive part is placed in prepare() where dialogs are used to fill parameters.
• only fully prepared Actions are placed in ActionQueue.
• ActionQueue obtains action instances from Registry, copies, prepares them, and places them in the queue.
• Action::clone() gets QueryOptions as param. This lets us either clone without params or really copy the instance.
• If action is called as COMMAND, params have been filled already.
• Reactions require a ActionQueue::getLastAction() to actually obtain result of (cloned) Action.
• FIX: Calculation now has const has...() and getResult().

Location:

src

Files:

• Actions/Action.cpp (modified) (2 diffs)
• Actions/Action.hpp (modified) (2 diffs)
• Actions/ActionQueue.cpp (modified) (2 diffs)
• Actions/ActionQueue.hpp (modified) (5 diffs)
• Actions/ActionSequence.cpp (modified) (1 diff)
• Actions/ActionSequence.hpp (modified) (1 diff)
• Actions/Action_impl_header.hpp (modified) (1 diff)
• Actions/Action_impl_pre.hpp (modified) (1 diff)
• Actions/AtomsCalculation.hpp (modified) (1 diff)
• Actions/AtomsCalculation_impl.hpp (modified) (1 diff)
• Actions/Calculation.hpp (modified) (3 diffs)
• Actions/Calculation_impl.hpp (modified) (1 diff)
• Actions/MakroAction.cpp (modified) (2 diffs)
• Actions/MakroAction.hpp (modified) (1 diff)
• Actions/MakroAction_impl_header.hpp (modified) (1 diff)
• Actions/MakroAction_impl_pre.hpp (modified) (1 diff)
• Actions/ManipulateAtomsProcess.cpp (modified) (1 diff)
• Actions/ManipulateAtomsProcess.hpp (modified) (2 diffs)
• Actions/MethodAction.cpp (modified) (1 diff)
• Actions/MethodAction.hpp (modified) (1 diff)
• Actions/Reaction.hpp (modified) (1 diff)
• Actions/Reaction_impl_header.hpp (modified) (1 diff)
• Actions/Reaction_impl_pre.hpp (modified) (3 diffs)
• Actions/unittests/ActionSequenceUnitTest.cpp (modified) (3 diffs)
• UIElements/CommandLineUI/CommandLineWindow.cpp (modified) (1 diff)
• UIElements/Menu/TextMenu/TxMenuLeaveAction.cpp (modified) (1 diff)
• UIElements/Menu/TextMenu/TxMenuLeaveAction.hpp (modified) (1 diff)

src/Actions/Action.cpp ¶

@@ -112 +112 @@
 }
 
-Dialog * Action::createDialog(){
-  Dialog *dialog = UIFactory::getInstance().makeDialog();
-  return fillDialog(dialog);
-}
-
-void Action::call(enum QueryOptions flag){
-  if(!isActive()){
-    return;
-  }
-  // forward to private virtual
+void Action::prepare(enum QueryOptions flag)
+{
+  // fill with
   if (flag == Interactive) {
     Dialog* dialog = createDialog();
@@ -130 +123 @@
     }
     delete(dialog);
+  }
+}
+
+Dialog * Action::createDialog(){
+  Dialog *dialog = UIFactory::getInstance().makeDialog();
+  return fillDialog(dialog);
+}
+
+void Action::call(){
+  if(!isActive()){
+    return;
   }
   ActionState::ptr state = Action::failure;

src/Actions/Action.hpp ¶

@@ -133 +133 @@
    * is thrown)
    */
-  void call(enum QueryOptions state = Interactive);
+  void call();
 
 public:
@@ -167 +167 @@
    */
   const std::string help() const;
+
+  /** Clones the Action.
+   *
+   */
+  virtual Action* clone(enum QueryOptions flag = Interactive) const=0;
+
+  /** Prepares the Action's parameters.
+   *
+   */
+  virtual void prepare(enum QueryOptions flag = Interactive);
 
   /** Prints what would be necessary to add the Action from the Command Line Interface.

src/Actions/ActionQueue.cpp ¶

@@ -53 +53 @@
 ActionQueue::ActionQueue() :
     AR(new ActionRegistry()),
-    history(new ActionHistory)
+    history(new ActionHistory),
+    CurrentAction(0)
 {}
 
 ActionQueue::~ActionQueue()
 {
-  queue.clear();
+  // free all actions contained in queue
+  for (ActionQueue_t::iterator iter = queue.begin(); !queue.empty(); iter = queue.begin()) {
+    delete *iter;
+    queue.erase(iter);
+  }
+
   delete history;
   delete AR;
@@ -65 +71 @@
 void ActionQueue::queueAction(const std::string &name, enum Action::QueryOptions state)
 {
-  Action* _action = AR->getActionByName(name);
-  queue.push_back(_action);
-  _action->call(state);
+  queueAction(AR->getActionByName(name), state);
 }
 
 void ActionQueue::queueAction(Action *_action, enum Action::QueryOptions state)
 {
-  queue.push_back(_action);
-  _action->call(state);
+  Action *newaction = _action->clone(state);
+  newaction->prepare(state);
+  queue.push_back( newaction );
+  newaction->call();
 }
 

src/Actions/ActionQueue.hpp ¶

@@ -16 +16 @@
 #include "CodePatterns/Singleton.hpp"
 
-#include <list>
 #include <vector>
 
@@ -38 +37 @@
 public:
   typedef std::vector<std::string> ActionTokens_t;
-  typedef std::list<Action *> ActionQueue_t;
+  typedef std::vector< Action * > ActionQueue_t;
 
   /** Queues the Action with \a name to be called.
@@ -104 +103 @@
   void outputAsPython(std::ostream &output) const;
 
-  /** Undoes last called Action.
+  /** Undoes last called Acfriend void ::cleanUp();tion.
    *
    */
@@ -113 +112 @@
    */
   void redoLast();
+
+  /** Getter for the last executed action.
+   *
+   * \note this is necessary for Reactions to actually have a chance of getting
+   * the calculated value as Action's are always cloned.
+   *
+   * \return const ref to last action
+   */
+  const Action &getLastAction() const {
+    return *(queue.back());
+  }
 
 private:
@@ -151 +161 @@
   //!> internal queue of actions
   ActionQueue_t queue;
+
+  //!> point to current action in queue
+  size_t CurrentAction;
 };
 

src/Actions/ActionSequence.cpp ¶

@@ -48 +48 @@
     loop(1)
 {}
+
+ActionSequence::ActionSequence(const ActionSequence &_other) :
+    loop(1)
+{
+  // we need to override copy cstor as we have pointer referenced objects
+  for(actionSet::iterator it=actions.begin(); it!=actions.end(); it++){
+    actions.push_back((*it)->clone());
+  }
+}
 
 ActionSequence::~ActionSequence()

src/Actions/ActionSequence.hpp ¶

@@ -32 +32 @@
 
   ActionSequence();
+  ActionSequence(const ActionSequence &_other);
   virtual ~ActionSequence();
 

src/Actions/Action_impl_header.hpp ¶

@@ -212 +212 @@
   bool shouldUndo();
 
+  Action* clone(enum QueryOptions flag = Interactive) const;
+
   void outputAsCLI(std::ostream &ost) const;
   void outputAsPython(std::ostream &ost, const std::string &prefix) const;

src/Actions/Action_impl_pre.hpp ¶

@@ -292 +292 @@
     {}
 
+// =========== clone Action ===========
+Action* ACTION::clone(enum QueryOptions flag) const
+{
+  if (flag == Interactive)
+    return new ACTION();
+  else
+    return new ACTION(*this);
+}
+
 // =========== fill a dialog ===========
 Dialog* ACTION::fillDialog(Dialog *dialog) {

src/Actions/AtomsCalculation.hpp ¶

@@ -28 +28 @@
   virtual ~AtomsCalculation();
 
+  Action* clone(enum Action::QueryOptions flag = Action::Interactive) const;
+
 protected:
   virtual std::vector<T>* doCalc();

src/Actions/AtomsCalculation_impl.hpp ¶

@@ -52 +52 @@
 
 template<typename T>
+Action* AtomsCalculation<T>::clone(enum Action::QueryOptions flag) const
+{
+  if (flag == Action::Interactive)
+    return new AtomsCalculation<T>(op, Action::Traits, descr);
+  else
+    return new AtomsCalculation<T>(*this);
+}
+
+template<typename T>
 Dialog *AtomsCalculation<T>::fillDialog(Dialog *dialog){
   ASSERT(dialog,"No Dialog given when filling action dialog");

src/Actions/Calculation.hpp ¶

@@ -42 +42 @@
   virtual bool shouldUndo();
 
+  virtual Action* clone(enum QueryOptions flag = Interactive) const=0;
+
   virtual void outputAsCLI(std::ostream &ost) const;
   virtual void outputAsPython(std::ostream &ost, const std::string &prefix) const;
@@ -55 +57 @@
    * Check if a cached result is available.
    */
-  virtual bool hasResult();
+  virtual bool hasResult() const;
 
   /**
@@ -61 +63 @@
    * Fails if there is no cached result.
    */
-  virtual T getResult();
+  virtual T getResult() const;
 
   /**

src/Actions/Calculation_impl.hpp ¶

@@ -88 +88 @@
 
 template<typename T>
-bool Calculation<T>::hasResult(){
+bool Calculation<T>::hasResult() const {
   return done;
 }
 
 template<typename T>
-T Calculation<T>::getResult(){
+T Calculation<T>::getResult() const {
   assert(done && "No result calculated");
   return *result;

src/Actions/MakroAction.cpp ¶

@@ -102 +102 @@
 
 ActionState::ptr MakroAction::performCall(){
-//  {
-//    // create and run our dialog and also of all members of the sequence
-//    Dialog* dialog = actions.fillAllDialogs(createDialog());
-//    if (dialog->hasQueries()) {
-//      if (!dialog->display())
-//        // dialog error or aborted -> throw exception
-//        throw ActionFailureException() << ActionNameString(getName());
-//    }
-//    delete(dialog);
-//  }
   ActionSequence::stateSet states = actions.callAll(true);
   return ActionState::ptr(new MakroActionState(states));
@@ -138 +128 @@
 }
 
+Action* MakroAction::clone(enum QueryOptions flag) const
+{
+  if (flag == Interactive)
+    return new MakroAction(Traits, actions);
+  else
+    return new MakroAction(*this);
+}
+
+void MakroAction::prepare(enum QueryOptions flag)
+{
+  if (flag == Interactive) {
+    // create and run our dialog and also of all members of the sequence
+    Dialog* dialog = createDialog();
+    if (dialog->hasQueries()) {
+      if (!dialog->display())
+        // dialog error or aborted -> throw exception
+        throw ActionFailureException() << ActionNameString(getName());
+    }
+    delete(dialog);
+  }
+}
+
 void MakroAction::outputAsCLI(std::ostream &ost) const
 {

src/Actions/MakroAction.hpp ¶

@@ -36 +36 @@
   bool canUndo();
   bool shouldUndo();
+
+  virtual Action* clone(enum QueryOptions flag = Interactive) const;
+  void prepare(enum QueryOptions flag = Interactive);
 
   virtual void outputAsCLI(std::ostream &ost) const;

src/Actions/MakroAction_impl_header.hpp ¶

@@ -218 +218 @@
   bool shouldUndo();
 
+  virtual Action* clone(enum QueryOptions flag = Interactive) const;
+
   void outputAsCLI(std::ostream &ost) const;
   void outputAsPython(std::ostream &ost, const std::string &prefix) const;

src/Actions/MakroAction_impl_pre.hpp ¶

@@ -291 +291 @@
     {}
 
+// =========== clone Action ===========
+Action* ACTION::clone(enum QueryOptions flag) const
+{
+  if (flag == Interactive)
+    return new ACTION();
+  else
+    return new ACTION(*this);
+}
+
 // =========== fill a dialog ===========
 Dialog* ACTION::fillOwnDialog(Dialog *dialog) {

src/Actions/ManipulateAtomsProcess.cpp ¶

@@ -103 +103 @@
   stop();
 }
+
+Action* ManipulateAtomsProcess::clone(enum QueryOptions flag) const
+{
+  if (flag == Interactive)
+    return new ManipulateAtomsProcess(operation, descr, Traits);
+  else
+    return new ManipulateAtomsProcess(*this);
+}

src/Actions/ManipulateAtomsProcess.hpp ¶

@@ -38 +38 @@
   virtual bool shouldUndo();
 
+  Action* clone(enum QueryOptions flag = Interactive) const;
+
   void outputAsCLI(std::ostream &ost) const;
   void outputAsPython(std::ostream &ost, const std::string &prefix) const;
@@ -47 +49 @@
    *
    */
-  void call(enum QueryOptions state = Interactive)
-  { Process::call(state); }
+  void call()
+  { Process::call(); }
 
 protected:

src/Actions/MethodAction.cpp ¶

@@ -83 +83 @@
 }
 
+Action* MethodAction::clone(enum QueryOptions flag) const
+{
+  if (flag == Interactive)
+    return new MethodAction(Traits, executeMethod);
+  else
+    return new MethodAction(*this);
+}
+
 void MethodAction::outputAsCLI(std::ostream &ost) const
 {}

src/Actions/MethodAction.hpp ¶

@@ -34 +34 @@
   virtual bool shouldUndo();
 
+  virtual Action* clone(enum QueryOptions flag = Interactive) const;
+
   void outputAsCLI(std::ostream &ost) const;
   void outputAsPython(std::ostream &ost, const std::string &prefix) const;

src/Actions/Reaction.hpp ¶

@@ -39 +39 @@
    */
   virtual bool canUndo();
+  virtual bool shouldUndo();
 
-  virtual bool shouldUndo();
+  virtual Action* clone(enum QueryOptions flag = Interactive) const=0;
 
   virtual void outputAsCLI(std::ostream &ost) const;

src/Actions/Reaction_impl_header.hpp ¶

@@ -206 +206 @@
   virtual ~REACTION();
 
+  Action* clone(enum QueryOptions flag = Interactive) const;
+
   void outputAsCLI(std::ostream &ost) const;
   void outputAsPython(std::ostream &ost, const std::string &prefix) const;

src/Actions/Reaction_impl_pre.hpp ¶

@@ -200 +200 @@
 }
 
+// =========== clone Action ===========
+Action* REACTION::clone(enum QueryOptions flag) const
+{
+  if (flag == Interactive)
+    return new REACTION();
+  else
+    return new REACTION(*this);
+}
+
 // =========== fill a dialog ===========
 Dialog* REACTION::fillDialog(Dialog *dialog) {
@@ -267 +276 @@
 #endif
   ActionQueue::getInstance().queueAction( ToCall, Action::NonInteractive);
-  Reaction< RETURNTYPE > * resultaction = static_cast<Reaction< RETURNTYPE > *>(ToCall);
-  ASSERT( resultaction != NULL,
-      "  COMMAND - static cast to Reaction type failed.");
-  ASSERT( resultaction->hasResult (),
-      " _COMMAND - result is not done yet?");
-  return resultaction->getResult();
+  RETURNTYPE result;
+  try {
+    const Reaction< RETURNTYPE > & resultaction =
+        static_cast<const Reaction< RETURNTYPE > &>(ActionQueue::getInstance().getLastAction());
+    ASSERT( resultaction.hasResult (),
+        " _COMMAND - result is not done yet?");
+    result = resultaction.getResult();
+  } ASSERT_NOCATCH("  COMMAND - static cast to Reaction type failed.");
+  return result;
 };
 
@@ -290 +302 @@
 #endif
   ActionQueue::getInstance().queueAction( ToCall, Action::NonInteractive);
-  Reaction< RETURNTYPE > * resultaction = static_cast<Reaction< RETURNTYPE > *>(ToCall);
-  ASSERT( resultaction != NULL,
-      "  COMMAND - static cast to Reaction type failed.");
-  ASSERT( resultaction->hasResult (),
-      " _COMMAND - result is not done yet?");
-  return resultaction->getResult();
+  RETURNTYPE result;
+  try {
+    const Reaction< RETURNTYPE > & resultaction =
+        static_cast<const Reaction< RETURNTYPE > &>(ActionQueue::getInstance().getLastAction());
+    ASSERT( resultaction.hasResult (),
+        " _COMMAND - result is not done yet?");
+    result = resultaction.getResult();
+  } ASSERT_NOCATCH("  COMMAND - static cast to Reaction type failed.");
+  return result;
 };
 

src/Actions/unittests/ActionSequenceUnitTest.cpp ¶

@@ -85 +85 @@
     return true;
   }
+  Action* clone(enum QueryOptions flag = Interactive) const
+  {
+    return new canUndoActionStub(Traits);
+  }
+  void prepare(enum QueryOptions flag = Interactive)
+  {}
   void outputAsCLI(std::ostream &ost) const
   {}
@@ -118 +124 @@
    return true;
   }
+  Action* clone(enum QueryOptions flag = Interactive) const
+  {
+    return new cannotUndoActionStub(Traits);
+  }
+  void prepare(enum QueryOptions flag = Interactive)
+  {}
   void outputAsCLI(std::ostream &ost) const
   {}
@@ -154 +166 @@
     return true;
   }
+  Action* clone(enum QueryOptions flag = Interactive) const
+  {
+    return new wasCalledActionStub(Traits);
+  }
+  void prepare(enum QueryOptions flag = Interactive)
+  {}
   void outputAsCLI(std::ostream &ost) const
   {}

src/UIElements/CommandLineUI/CommandLineWindow.cpp ¶

@@ -69 +69 @@
 
   // go through all possible actions
-  LOG(0, "Calling Actions ... ");
   for (std::list<std::string>::iterator CommandRunner = CommandLineParser::getInstance().SequenceOfActions.begin(); CommandRunner != CommandLineParser::getInstance().SequenceOfActions.end(); ++CommandRunner) {
     if (AQ.isActionKnownByName(*CommandRunner)) {
 //      LOG1, "INFO: Checking presence of " << *CommandRunner << ": " << "queuing.");
-      LOG(1, "INFO: Queueing " << *CommandRunner << "...");
       AQ.queueAction(*CommandRunner);
     } else {

src/UIElements/Menu/TextMenu/TxMenuLeaveAction.cpp ¶

@@ -71 +71 @@
 }
 
+Action* TxMenu::LeaveAction::clone(enum QueryOptions flag) const
+{
+  if (flag == Interactive)
+    return new TxMenu::LeaveAction(menu, Traits);
+  else
+    return new TxMenu::LeaveAction(*this);
+}
+
 void TxMenu::LeaveAction::outputAsCLI(std::ostream &ost) const
 {}

src/UIElements/Menu/TextMenu/TxMenuLeaveAction.hpp ¶

@@ -33 +33 @@
   bool shouldUndo();
 
+  Action* clone(enum QueryOptions flag = Interactive) const;
+
   void outputAsCLI(std::ostream &ost) const;
   void outputAsPython(std::ostream &ost, const std::string &prefix) const;