Changeset f3db60 for src/Actions/ActionQueue.hpp

Timestamp:

Jun 11, 2015, 11:21:40 PM (10 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:

fae462

Parents:

0907ad

git-author:

Frederik Heber <heber@…> (05/15/15 07:12:44)

git-committer:

Frederik Heber <heber@…> (06/11/15 23:21:40)

Message:

Added DryRun and NoDryRun actions.

• actions (un)set a flag inside ActionQueue to which only those permitted by an advocate pattern have access.
• added testsuite tests for both dry-run, no-dry-run, and storing sessions.
• explained use of action in userguide.

File:

• src/Actions/ActionQueue.hpp (modified) (5 diffs)

src/Actions/ActionQueue.hpp

@@ -40 +40 @@
 class ActionRegistry;
 class ActionTrait;
+class DryRunAdvocate;
 
 namespace Queuedetail {
@@ -178 +179 @@
   { return StatusList; }
 
+  /** Getter for isDryRun state flag.
+   *
+   * \return true - ActionQueue does not execute Actions but skips, false - else
+   */
+  bool getDryRun() const
+  { return dryrun_flag; }
+
 private:
   //!> grant Action access to internal history functions.
@@ -183 +191 @@
   //!> grant CommandLineParser access to stop and clearQueue()
   friend class ::CommandLineParser;
+  //!> grant Advocate access to setting dryrun
+  friend class DryRunAdvocate;
 
   /** Wrapper function to add state to ActionHistory.
@@ -255 +265 @@
   void insertAction(Action *_action, enum Action::QueryOptions state);
 
+  /** Sets the current state of the \a isDryRun flag.
+   *
+   * \param _dryrun true - Actions will not get executed anymore, false - else
+   */
+  void setDryRun(const bool _dryrun)
+  { dryrun_flag = _dryrun; }
+
+  /** Checks whether next Action should be skipped or not.
+   *
+   * \param _nextaction next action to execute to inspect whether it unsets dryrun_flag
+   * \return true - dryrun_flag set and \a _nextaction is not unsetting dry run
+   */
+  bool isDryRun(const Action *_nextaction) const;
+
 private:
   /** Private cstor for ActionQueue.
@@ -309 +333 @@
   //!> internal list of status messages from Actions for UIs to display
   ActionStatusList StatusList;
+
+  //!> internal flag whether to call or skip actions (i.e. do a dry run)
+  bool dryrun_flag;
 };
 namespace Queuedetail {