Changeset 690741 for src/Actions

Timestamp:

Sep 19, 2013, 8:23:52 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:

a6ceab

Parents:

1d3563

git-author:

Frederik Heber <heber@…> (08/16/13 11:47:48)

git-committer:

Frederik Heber <heber@…> (09/19/13 20:23:52)

Message:

Added getListOfActions() and getActionsTrait() to completely wrap ActionRegistry.

Location:

src/Actions

Files:

• ActionQueue.cpp (modified) (2 diffs)
• ActionQueue.hpp (modified) (4 diffs)
• CommandAction/HelpAction.cpp (modified) (1 diff)
• OptionRegistry.cpp (modified) (2 diffs)
• unittests/ActionRegistryUnitTest.cpp (modified) (2 diffs)
• unittests/ActionRegistryUnitTest.hpp (modified) (2 diffs)

src/Actions/ActionQueue.cpp

@@ -37 +37 @@
 #include "Actions/ActionQueue.hpp"
 
+#include "CodePatterns/Assert.hpp"
+#include "CodePatterns/IteratorAdaptors.hpp"
 #include "CodePatterns/Singleton_impl.hpp"
+
+#include <vector>
 
 using namespace MoleCuilder;
@@ -62 +66 @@
 }
 
+const ActionTrait& ActionQueue::getActionsTrait(const std::string name) const
+{
+  // this const_cast is just required as long as we have a non-const getActionByName
+  const Action * const action = const_cast<ActionQueue *>(this)->getActionByName(name);
+  return action->Traits;
+}
+
+const ActionQueue::ActionTokens_t ActionQueue::getListOfActions() const
+{
+  ActionTokens_t returnlist;
+
+  returnlist.insert(
+      returnlist.end(),
+      MapKeyConstIterator<ActionRegistry::const_iterator>(AR.getBeginIter()),
+      MapKeyConstIterator<ActionRegistry::const_iterator>(AR.getEndIter()));
+
+  return returnlist;
+}
+
 CONSTRUCT_SINGLETON(ActionQueue)

src/Actions/ActionQueue.hpp

@@ -17 +17 @@
 
 #include <list>
+#include <vector>
 
 #include "Actions/ActionRegistry.hpp"
@@ -33 +34 @@
   friend class Singleton<ActionQueue>;
 public:
+  typedef std::vector<std::string> ActionTokens_t;
   typedef std::list<Action *> ActionQueue_t;
 
@@ -57 +59 @@
   int getLastPosition(const std::string &MenuName) const;
 
+  /** Returns the vector with the tokens of all currently known Actions.
+   *
+   * \return list of all tokens
+   */
+  const ActionTokens_t getListOfActions() const;
+
+  /** Returns the trait to an Action.
+   *
+   * \param name name of Action
+   * \return const ref to its default Trait.
+   */
+  const ActionTrait& getActionsTrait(const std::string name) const;
+
   /** Getter function for the ActionRegistry for transitional purpose.
    *
@@ -64 +79 @@
     return AR;
   }
-
 
 private:

src/Actions/CommandAction/HelpAction.cpp

@@ -79 +79 @@
   // print list of actions or its options
   ActionQueue &AQ = ActionQueue::getInstance();
-  ActionRegistry &AR = AQ.getActionRegistry();
+  ActionQueue::ActionTokens_t tokens = AQ.getListOfActions();
   if (params.actionname.get() == std::string("none")) {
     // print list of all Actions
     std::cout << "Here is a list of all available Actions:" << std::endl;
-    for(ActionRegistry::const_iterator iter = AR.getBeginIter();
-        iter != AR.getEndIter();
+    for(ActionQueue::ActionTokens_t::const_iterator iter = tokens.begin();
+        iter != tokens.end();
         ++iter) {
-      const Action *instance = iter->second;
-      std::cout << "'" << iter->first << "': \t "
-          << instance->Traits.getDescription() << std::endl;
+      std::cout << "'" << *iter << "': \t "
+          << AQ.getActionsTrait(*iter).getDescription() << std::endl;
     }
   } else {

src/Actions/OptionRegistry.cpp

@@ -71 +71 @@
 //void OptionRegistry::Init()
 //{
-//  ActionRegistry &AR = ActionQueue::getInstance().getActionRegistry();
-//  for (ActionRegistry::const_iterator actioniter = AR.getBeginIter();
-//      actioniter != AR.getEndIter();
+//  ActionQueue &AQ = ActionQueue::getInstance();
+//  ActionQueue::ActionTokens_t tokens = AQ.getListOfActions();
+//  for (ActionQueue::ActionTokens_t::const_iterator actioniter = tokens.begin();
+//      actioniter != tokens.end();
 //      ++actioniter) {
-//    Action* const currentAction = actioniter->second;
-//    for (ActionTrait::options_const_iterator optioniter = currentAction->Traits.getBeginIter();
-//        optioniter != currentAction->Traits.getEndIter();
+//    const ActionTrait& currentTrait = AQ.getActionsTrait(*actioniter);
+//    for (ActionTrait::options_const_iterator optioniter = currentTrait.getBeginIter();
+//        optioniter != currentTrait.getEndIter();
 //        ++optioniter) {
 //      // wrap option in a shared_ptr to have it exist till and automatically removed at end of code
 //      std::string const &OptionName = optioniter->first;
-//      std::type_info const &typeDesired = *((actioniter->second)->Traits.getOptionType(OptionName));
+//      std::type_info const &typeDesired = *(currentTrait.getOptionType(OptionName));
 //      if (isOptionPresentByName(OptionName)) {
 //        std::type_info const &typePresent = *(getOptionByName(OptionName)->getType());
@@ -98 +99 @@
 void OptionRegistry::ConsistencyCheck()
 {
-  ActionRegistry &AR = ActionQueue::getInstance().getActionRegistry();
-  for (ActionRegistry::const_iterator actioniter = AR.getBeginIter();
-      actioniter != AR.getEndIter();
+  ActionQueue &AQ = ActionQueue::getInstance();
+  ActionQueue::ActionTokens_t tokens = AQ.getListOfActions();
+  for (ActionQueue::ActionTokens_t::const_iterator actioniter = tokens.begin();
+      actioniter != tokens.end();
       ++actioniter) {
-    for (ActionTrait::options_const_iterator optioniter = (actioniter->second)->Traits.getBeginIter();
-        optioniter != (actioniter->second)->Traits.getEndIter();
+    const ActionTrait& currentTrait = AQ.getActionsTrait(*actioniter);
+    for (ActionTrait::options_const_iterator optioniter = currentTrait.getBeginIter();
+        optioniter != currentTrait.getEndIter();
         ++optioniter) {
 #ifndef NDEBUG
       std::string const &OptionName = optioniter->first;
-      std::type_info const &typeDesired = *((actioniter->second)->Traits.getOption(OptionName).getType());
+      std::type_info const &typeDesired = *(currentTrait.getOption(OptionName).getType());
       std::type_info const &typePresent = *(getOptionByName(OptionName)->getType());
 #endif

src/Actions/unittests/ActionRegistryUnitTest.cpp

@@ -61 +61 @@
 void ActionRegistryTest::setUp()
 {
-  AR = &ActionQueue::getInstance().getActionRegistry();
 };
 
@@ -74 +73 @@
   std::map <std::string, std::string> result;
 
-  for (ActionRegistry::const_iterator iter = AR->getBeginIter(); iter != AR->getEndIter(); ++iter) {
-    if ((iter->second)->Traits.hasShortForm()) {
-      ASSERT(result.find((iter->second)->Traits.getShortForm()) == result.end(),
-          "Short form "+toString((iter->second)->Traits.getShortForm())+
-          " for action "+toString(iter->first)+" already present from "+
-          std::string(result[(iter->second)->Traits.getShortForm()])+"!");
-      result[(iter->second)->Traits.getShortForm()] = (iter->second)->getName();
+  ActionQueue &AQ = ActionQueue::getInstance();
+  ActionQueue::ActionTokens_t tokens = AQ.getListOfActions();
+  for (ActionQueue::ActionTokens_t::const_iterator iter = tokens.begin();
+      iter != tokens.end(); ++iter) {
+    const ActionTrait &CurrentTrait = AQ.getActionsTrait(*iter);
+    if (CurrentTrait.hasShortForm()) {
+      ASSERT(result.find(CurrentTrait.getShortForm()) == result.end(),
+          "Short form "+toString(CurrentTrait.getShortForm())+
+          " for action "+toString(*iter)+" already present from "+
+          std::string(result[CurrentTrait.getShortForm()])+"!");
+      result[CurrentTrait.getShortForm()] = *iter;
     }
   }

src/Actions/unittests/ActionRegistryUnitTest.hpp

@@ -17 +17 @@
 #include <cppunit/extensions/HelperMacros.h>
 
-namespace MoleCuilder {
-class ActionRegistry;
-};
-
 /********************************************** Test classes **************************************/
 
@@ -33 +29 @@
       void tearDown();
       void CheckDoublyUsedShortforms();
-
-private:
-      MoleCuilder::ActionRegistry *AR;
 };