Changeset 0b2ce9 for src/Actions/AnalysisAction

Timestamp:

Aug 26, 2010, 9:13:11 PM (15 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:

9ee38b

Parents:

9c1c89

git-author:

Frederik Heber <heber@…> (08/25/10 13:22:58)

git-committer:

Frederik Heber <heber@…> (08/26/10 21:13:11)

Message:

Implemented macros for automatically generating repetitive stuff around Actions.

The idea is that only the following items have to be provided for by the user

• parameters (i.e. for each the following tupel: type, token and reference)
• perform...(), ...Undo(), ...

Therefore, we have three new files:

• Action_impl_header.hpp: Is for the declarations in the header
• Action_impl_pre.hpp: Is before definition of functions
• Action_impl_post.hpp: is after definition of functions (cleanup)

Changes:

• MolecularVolumeAction() has already been refactored accordingly.
• new struct ActionParameters, alike to ActionState, to be specialized for each Action's parameters
• new function Action::getParametersfromValueStorage() handles retrieval of parameters from ValueStorage.

Location:

src/Actions/AnalysisAction

Files:

• MolecularVolumeAction.cpp (modified) (3 diffs)
• MolecularVolumeAction.hpp (modified) (1 diff)
• PairCorrelationAction.cpp (modified) (1 diff)
• PairCorrelationAction.hpp (modified) (1 diff)
• PointCorrelationAction.cpp (modified) (1 diff)
• PointCorrelationAction.hpp (modified) (1 diff)
• PrincipalAxisSystemAction.cpp (modified) (1 diff)
• PrincipalAxisSystemAction.hpp (modified) (1 diff)
• SurfaceCorrelationAction.cpp (modified) (1 diff)
• SurfaceCorrelationAction.hpp (modified) (1 diff)

src/Actions/AnalysisAction/MolecularVolumeAction.cpp

@@ -20 +20 @@
 #include "Helpers/MemDebug.hpp"
 
-#include "Actions/AnalysisAction/MolecularVolumeAction.hpp"
-#include "Actions/ActionRegistry.hpp"
 #include "boundary.hpp"
 #include "config.hpp"
@@ -36 +34 @@
 using namespace std;
 
-#include "UIElements/UIFactory.hpp"
-#include "UIElements/Dialog.hpp"
-#include "Actions/ValueStorage.hpp"
+#include "Actions/AnalysisAction/MolecularVolumeAction.hpp"
 
-const char AnalysisMolecularVolumeAction::NAME[] = "molecular-volume";
+// and construct the stuff
+#include "Action_impl_pre.hpp"
 
-AnalysisMolecularVolumeAction::AnalysisMolecularVolumeAction() :
-  Action(NAME)
-{}
-
-AnalysisMolecularVolumeAction::~AnalysisMolecularVolumeAction()
-{}
-
-void AnalysisMolecularVolume() {
-  ActionRegistry::getInstance().getActionByName(AnalysisMolecularVolumeAction::NAME)->call(Action::NonInteractive);
-};
-
-Dialog * AnalysisMolecularVolumeAction::fillDialog(Dialog *dialog) {
-  ASSERT(dialog,"No Dialog given when filling action dialog");
-  dialog->queryEmpty(NAME, ValueStorage::getInstance().getDescription(NAME));
-
-  return dialog;
-}
-
-Action::state_ptr AnalysisMolecularVolumeAction::performCall() {
-  int molID = -1;
+/** =========== define the function ====================== */
+Action::state_ptr ACTION::performCall() {
   // obtain information
-  ValueStorage::getInstance().queryCurrentValue(NAME, molID);
+  getParametersfromValueStorage();
 
   // execute action
@@ -87 +66 @@
 }
 
-Action::state_ptr AnalysisMolecularVolumeAction::performUndo(Action::state_ptr _state) {
+Action::state_ptr ACTION::performUndo(Action::state_ptr _state) {
   return Action::success;
 }
 
-Action::state_ptr AnalysisMolecularVolumeAction::performRedo(Action::state_ptr _state){
+Action::state_ptr ACTION::performRedo(Action::state_ptr _state){
   return Action::success;
 }
 
-bool AnalysisMolecularVolumeAction::canUndo() {
+bool ACTION::canUndo() {
   return true;
 }
 
-bool AnalysisMolecularVolumeAction::shouldUndo() {
+bool ACTION::shouldUndo() {
   return true;
 }
 
-const string AnalysisMolecularVolumeAction::getName() {
+const string ACTION::getName() {
   return NAME;
 }
+/** =========== end of function ====================== */
+
+// and clean the stuff
+#include "Action_impl_post.hpp"

src/Actions/AnalysisAction/MolecularVolumeAction.hpp

@@ -16 +16 @@
 #include "Actions/Action.hpp"
 
-void AnalysisMolecularVolume();
+// i.e. there is an integer with variable name Z that can be found in
+// ValueStorage by the token "Z" -> first column: int, Z, "Z"
+// "undefine" if no parameters are required
+//#define types (int)
+//#define references (molID)
+//#define tokens (NAME)
+// some defines for all the names, you may use ACTION, STATE and PARAMS
+#define CATEGORY Analysis
+#define ACTIONNAME MolecularVolume
+#define TOKEN "molecular-volume"
 
-class AnalysisMolecularVolumeAction : public Action {
-  friend void AnalysisMolecularVolume();
-public:
-  AnalysisMolecularVolumeAction();
-  virtual ~AnalysisMolecularVolumeAction();
-
-  bool canUndo();
-  bool shouldUndo();
-
-  virtual const std::string getName();
-
-protected:
-  virtual Dialog * fillDialog(Dialog*);
-private:
-  virtual Action::state_ptr performCall();
-  virtual Action::state_ptr performUndo(Action::state_ptr);
-  virtual Action::state_ptr performRedo(Action::state_ptr);
-
-  static const char NAME[];
-};
+#include "Action_impl_header.hpp"
 
 #endif /* MOLECULARVOLUMEACTION_HPP_ */

src/Actions/AnalysisAction/PairCorrelationAction.cpp

@@ -62 +62 @@
 };
 
+
+void AnalysisPairCorrelationAction::getParametersfromValueStorage()
+{};
 
 Dialog* AnalysisPairCorrelationAction::fillDialog(Dialog* dialog) {

src/Actions/AnalysisAction/PairCorrelationAction.hpp

@@ -35 +35 @@
   virtual Dialog * fillDialog(Dialog*);
 private:
-   virtual Action::state_ptr performCall();
+   virtual void getParametersfromValueStorage();
+  virtual Action::state_ptr performCall();
   virtual Action::state_ptr performUndo(Action::state_ptr);
   virtual Action::state_ptr performRedo(Action::state_ptr);

src/Actions/AnalysisAction/PointCorrelationAction.cpp

@@ -63 +63 @@
   ActionRegistry::getInstance().getActionByName(AnalysisPointCorrelationAction::NAME)->call(Action::NonInteractive);
 };
+
+void AnalysisPointCorrelationAction::getParametersfromValueStorage()
+{};
 
 Dialog* AnalysisPointCorrelationAction::fillDialog(Dialog *dialog) {

src/Actions/AnalysisAction/PointCorrelationAction.hpp

@@ -37 +37 @@
   virtual Dialog * fillDialog(Dialog*);
 private:
+  virtual void getParametersfromValueStorage();
   virtual Action::state_ptr performCall();
   virtual Action::state_ptr performUndo(Action::state_ptr);

src/Actions/AnalysisAction/PrincipalAxisSystemAction.cpp

@@ -50 +50 @@
   ActionRegistry::getInstance().getActionByName(AnalysisPrincipalAxisSystemAction::NAME)->call(Action::NonInteractive);
 };
+
+void AnalysisPrincipalAxisSystemAction::getParametersfromValueStorage()
+{};
 
 Dialog* AnalysisPrincipalAxisSystemAction::fillDialog(Dialog *dialog) {

src/Actions/AnalysisAction/PrincipalAxisSystemAction.hpp

@@ -27 +27 @@
   virtual Dialog * fillDialog(Dialog *);
 private:
+  virtual void getParametersfromValueStorage();
   virtual Action::state_ptr performCall();
   virtual Action::state_ptr performUndo(Action::state_ptr);

src/Actions/AnalysisAction/SurfaceCorrelationAction.cpp

@@ -64 +64 @@
 };
 
+
+void AnalysisSurfaceCorrelationAction::getParametersfromValueStorage()
+{};
 
 Dialog* AnalysisSurfaceCorrelationAction::fillDialog(Dialog *dialog) {

src/Actions/AnalysisAction/SurfaceCorrelationAction.hpp

@@ -31 +31 @@
   virtual Dialog * fillDialog(Dialog*);
 private:
+  virtual void getParametersfromValueStorage();
   virtual Action::state_ptr performCall();
   virtual Action::state_ptr performUndo(Action::state_ptr);