source: src/Actions/Action_impl_header.hpp@ 862b6a

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
Last change on this file since 862b6a was 862b6a, checked in by Frederik Heber <heber@…>, 13 years ago

All Actions are timed now, timings are given on exit.

  • Chronos is used for this.
  • new function printTiming() called in cleanUp().
  • Property mode set to 100644
File size: 7.3 KB
Line 
1/*
2 * Action_impl_header.hpp
3 *
4 * Created on: Aug 25, 2010
5 * Author: heber
6 */
7
8// include config.h
9#ifdef HAVE_CONFIG_H
10#include <config.h>
11#endif
12
13#include <boost/preprocessor/cat.hpp>
14#include <boost/preprocessor/comparison/equal.hpp>
15#include <boost/preprocessor/comparison/not_equal.hpp>
16#include <boost/preprocessor/control/if.hpp>
17#include <boost/preprocessor/debug/assert.hpp>
18#include <boost/preprocessor/iteration/local.hpp>
19#include <boost/preprocessor/punctuation/comma_if.hpp>
20#include <boost/preprocessor/repetition/repeat.hpp>
21#include <boost/preprocessor/seq/elem.hpp>
22#include <boost/preprocessor/seq/push_back.hpp>
23#include <boost/preprocessor/seq/seq.hpp>
24#include <boost/preprocessor/seq/size.hpp>
25#include <boost/preprocessor/seq/transform.hpp>
26
27#include <iostream>
28#include <typeinfo>
29
30#include "Actions/ActionTraits.hpp"
31#include "Actions/OptionTrait.hpp"
32#include "Actions/ValueStorage.hpp"
33
34// some derived names: if CATEGORY is not given, we don't prefix with it
35#ifdef CATEGORY
36#define ACTION BOOST_PP_CAT(CATEGORY, BOOST_PP_CAT(ACTIONNAME, Action))
37#define COMMAND BOOST_PP_CAT(CATEGORY, ACTIONNAME)
38#define PARAMS BOOST_PP_CAT(CATEGORY, BOOST_PP_CAT(ACTIONNAME, Parameters))
39#else
40#define ACTION BOOST_PP_CAT(ACTIONNAME, Action)
41#define COMMAND ACTIONNAME
42#define PARAMS BOOST_PP_CAT(ACTIONNAME, Parameters)
43#endif
44// check if no lists given
45#ifndef paramtypes
46#define MAXPARAMTYPES 0
47#else
48#define MAXPARAMTYPES BOOST_PP_SEQ_SIZE(paramtypes)
49#endif
50
51// check user has given name and category
52#ifndef ACTIONNAME
53ERROR: No "ACTIONNAME" defined in: __FILE__
54#endif
55
56// calculate numbers and check whether all have same size
57#ifdef paramtokens
58BOOST_PP_ASSERT_MSG(BOOST_PP_EQUAL(MAXPARAMTYPES, BOOST_PP_SEQ_SIZE(paramtokens)),\
59 ERROR: There are not the same number of "paramtokens" and "paramtypes" in: __FILE__ \
60)
61#endif
62#ifdef paramreferences
63BOOST_PP_ASSERT_MSG(BOOST_PP_EQUAL(MAXPARAMTYPES, BOOST_PP_SEQ_SIZE(paramreferences)),\
64 ERROR: There are not the same number of "paramtokens" and "paramreferences" in: __FILE__ \
65)
66#endif
67#ifdef paramdescriptions
68BOOST_PP_ASSERT_MSG(BOOST_PP_EQUAL(MAXPARAMTYPES, BOOST_PP_SEQ_SIZE(paramdescriptions)),\
69 ERROR: There are not the same number of "paramtokens" and "paramdescriptions" in: __FILE__ \
70)
71#endif
72
73// check for mandatory defines
74#ifndef DESCRIPTION
75BOOST_PP_ASSERT_MSG(0, \
76 "ERROR: Description is mandatory for Actions, here for ACTION " \
77)
78#endif
79
80// check if paramdefaults is given, otherwise fill list with NODEFAULT
81// this does not work: paramdefaults has to be completely defined before
82// being used within option_print (used as an array there and not as
83// some function call still to be expanded)
84//#define paramdefaults (NODEFAULT)
85//#define tempvalue(z,n,value)
86// BOOST_PP_CAT(value,(NODEFAULT))
87//BOOST_PP_REPEAT(tempvalue, MAXPARAMTYPES, paramdefaults)
88//#undef tempvalue
89//#else
90
91// if present, check if correct number of arguments
92#ifdef paramdefaults
93BOOST_PP_ASSERT_MSG(BOOST_PP_EQUAL(MAXPARAMTYPES, BOOST_PP_SEQ_SIZE(paramdefaults)),\
94 ERROR: There are not the same number of "paramtokens" and "paramdefaults" in: __FILE__ \
95)
96#endif
97
98// print a list of type ref followed by a separator, i.e. "int i;"
99#define type_print(z,n,TYPELIST, VARLIST, separator) \
100 BOOST_PP_SEQ_ELEM(n, TYPELIST) \
101 BOOST_PP_SEQ_ELEM(n, VARLIST)\
102 separator
103
104// print a list of type ref followed, i.e. "int i, double position"
105#define type_list(z,n,TYPELIST, VARLIST) \
106 BOOST_PP_COMMA_IF(n)\
107 BOOST_PP_SEQ_ELEM(n, TYPELIST) \
108 BOOST_PP_SEQ_ELEM(n, VARLIST)
109
110// prints Options.insert
111#ifdef paramdefaults
112#define option_print(z,n,unused, unused2) \
113 tester = Options. insert (\
114 std::pair< std::string, OptionTrait *> ( \
115 BOOST_PP_SEQ_ELEM(n, paramtokens), \
116 new OptionTrait(\
117 BOOST_PP_SEQ_ELEM(n, paramtokens), \
118 &typeid( BOOST_PP_SEQ_ELEM(n, paramtypes) ), \
119 BOOST_PP_SEQ_ELEM(n, paramdescriptions), \
120 std::string( BOOST_PP_SEQ_ELEM(n, paramdefaults) ) )\
121 )\
122 ); \
123 ASSERT(tester.second, "ActionTrait<ACTION>::ActionTrait<ACTION>() option token present twice!");
124#else
125#define option_print(z,n,unused, unused2) \
126 tester = Options. insert (\
127 std::pair< std::string, OptionTrait *> ( \
128 BOOST_PP_SEQ_ELEM(n, paramtokens), \
129 new OptionTrait(\
130 BOOST_PP_SEQ_ELEM(n, paramtokens), \
131 &typeid( BOOST_PP_SEQ_ELEM(n, paramtypes) ), \
132 BOOST_PP_SEQ_ELEM(n, paramdescriptions), \
133 NODEFAULT )\
134 )\
135 ); \
136 ASSERT(tester.second, "ActionTrait<ACTION>::ActionTrait<ACTION>() option token present twice!");
137#endif
138
139namespace MoleCuilder {
140
141#if defined paramtypes && defined paramreferences
142void COMMAND(
143#define BOOST_PP_LOCAL_MACRO(n) type_list(~, n, paramtypes, paramreferences)
144#define BOOST_PP_LOCAL_LIMITS (0, MAXPARAMTYPES-1)
145#include BOOST_PP_LOCAL_ITERATE()
146 );
147# else
148void COMMAND();
149#endif
150
151class ACTION;
152
153template <>
154class ActionTrait<ACTION> : public ActionTraits {
155public:
156 ActionTrait() :
157#ifndef SHORTFORM
158 ActionTraits(OptionTrait(TOKEN, &typeid(void), DESCRIPTION, std::string()))
159#else
160 ActionTraits(OptionTrait(TOKEN, &typeid(void), DESCRIPTION, std::string(), SHORTFORM))
161#endif /* SHORTFORM */
162 {
163 // initialize remainder of action info
164#ifdef MENUNAME
165 MenuTitle = MENUNAME;
166#endif
167#ifdef MENUPOSITION
168 MenuPosition = MENUPOSITION;
169#endif
170
171 // initialize action's options
172 std::pair< ActionTraits::options_iterator, bool > tester;
173#ifdef paramtokens
174#define BOOST_PP_LOCAL_MACRO(n) option_print(~, n, ~, )
175#define BOOST_PP_LOCAL_LIMITS (0, MAXPARAMTYPES-1)
176#include BOOST_PP_LOCAL_ITERATE()
177#endif
178 // associate action's short form also with option
179#ifdef SHORTFORM
180 if (Options.find(TOKEN) != Options.end())
181 Options[TOKEN]->setShortForm(std::string(SHORTFORM));
182#endif /* SHORTFORM */
183 //std::cout << "ActionTrait<ACTION>::ActionTrait() with " << getName() << ", type " << getTypeName() << " and description " << getDescription() << std::endl;
184 }
185
186 ~ActionTrait() {}
187};
188
189class ACTION : public Action {
190 #if defined paramtypes && defined paramreferences
191 friend void COMMAND(
192 #define BOOST_PP_LOCAL_MACRO(n) type_list(~, n, paramtypes, paramreferences)
193 #define BOOST_PP_LOCAL_LIMITS (0, MAXPARAMTYPES-1)
194 #include BOOST_PP_LOCAL_ITERATE()
195 );
196 # else
197 void COMMAND();
198 #endif
199
200public:
201 ACTION();
202 virtual ~ACTION();
203
204 bool canUndo();
205 bool shouldUndo();
206
207 struct PARAMS : ActionParameters {
208 #if defined paramtypes && defined paramreferences
209 #define BOOST_PP_LOCAL_MACRO(n) type_print(~, n, paramtypes, paramreferences, ;)
210 #define BOOST_PP_LOCAL_LIMITS (0, MAXPARAMTYPES-1)
211 #include BOOST_PP_LOCAL_ITERATE()
212 #endif
213 } params;
214
215protected:
216 virtual Dialog * fillDialog(Dialog*);
217
218 void startTimer() const;
219 void endTimer() const;
220
221private:
222 virtual void getParametersfromValueStorage();
223 virtual Action::state_ptr performCall();
224 virtual Action::state_ptr performUndo(Action::state_ptr);
225 virtual Action::state_ptr performRedo(Action::state_ptr);
226};
227
228}
229
230#undef paramtypes
231#undef paramtokens
232#undef paramreferences
233#undef paramdescriptions
234#undef paramdefaults
235#undef MAXPARAMTYPES
236#undef statetypes
237#undef statereferences
238#undef MAXSTATETYPES
239
240#undef ACTION
241#undef COMMAND
242#undef COMMANDFULL
243#undef PARAMS
244
245#undef ACTIONNAME
246#undef CATEGORY
247#undef MENUNAME
248#undef MENUPOSITION
249#undef TOKEN
250
251#undef DESCRIPTION
252#undef SHORTFORM
Note: See TracBrowser for help on using the repository browser.