source: src/Actions/Action.cpp@ e4b2f6

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 e4b2f6 was e4b2f6, checked in by Frederik Heber <heber@…>, 14 years ago

Added Action::help().

  • Action::help() returns a string that enlists all of its options including type of argument and default values. This will be used by HelpAction.
  • Property mode set to 100644
File size: 5.5 KB
Line 
1/*
2 * Project: MoleCuilder
3 * Description: creates and alters molecular systems
4 * Copyright (C) 2010 University of Bonn. All rights reserved.
5 * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
6 */
7
8/*
9 * Action.cpp
10 *
11 * Created on: Dec 8, 2009
12 * Author: crueger
13 */
14
15// include config.h
16#ifdef HAVE_CONFIG_H
17#include <config.h>
18#endif
19
20#include "CodePatterns/MemDebug.hpp"
21
22#include <iostream>
23#include <sstream>
24#include <string>
25
26#include "Actions/Action.hpp"
27#include "Actions/ActionRegistry.hpp"
28#include "Actions/ActionHistory.hpp"
29#include "Actions/OptionRegistry.hpp"
30#include "Actions/OptionTrait.hpp"
31//#include "Actions/ValueStorage.hpp"
32#include "UIElements/Dialog.hpp"
33#include "CodePatterns/Assert.hpp"
34#include "CodePatterns/MemDebug.hpp"
35#include "UIElements/UIFactory.hpp"
36
37#include "CodePatterns/Log.hpp"
38#include "CodePatterns/Verbose.hpp"
39
40using namespace std;
41
42Action::state_ptr getEmptyState() {
43 return Action::state_ptr(Memory::ignore(new ActionState()));
44}
45
46// An empty state to indicate success
47Action::state_ptr Action::success = getEmptyState();
48Action::state_ptr Action::failure = getEmptyState();
49
50Action::Action(const ActionTraits &_Traits, bool _doRegister) :
51 Traits(_Traits)
52{
53 // register with ActionRegistry
54 if(_doRegister){
55 ActionRegistry::getInstance().registerInstance(this);
56 }
57
58 // register with OptionRegistry
59 for (ActionTraits::options_const_iterator optioniter = Traits.getBeginIter();
60 optioniter != Traits.getEndIter();
61 ++optioniter) {
62 // options may have been re-used by other Actions, so check beforehand whether adding is needed
63 if (!OptionRegistry::getInstance().isOptionPresentByName((optioniter->first))) {
64 OptionRegistry::getInstance().registerInstance(optioniter->second);
65 } else { // if present, ASSERT that types coincide
66#ifndef NDEBUG
67 OptionTrait const * const PresentOption = OptionRegistry::getInstance().getOptionByName(optioniter->first);
68#endif
69 ASSERT(PresentOption->getType() == optioniter->second->getType(),
70 ("Action::Action() - option to add "+
71 std::string(optioniter->first)+
72 " of Action "+
73 std::string(getName())+
74 " is already present with different type: "
75 +toString(PresentOption->getType())+" != "+toString(optioniter->second->getType())
76 )
77 );
78 ASSERT(PresentOption->getDefaultValue() == optioniter->second->getDefaultValue(),
79 ("Action::Action() - option to add "+
80 std::string(optioniter->first)+
81 " of Action "+
82 std::string(getName())+
83 " is already present with different default value: "
84 +PresentOption->getDefaultValue()+" != "+optioniter->second->getDefaultValue()
85 )
86 );
87 ASSERT(PresentOption->getShortForm() == optioniter->second->getShortForm(),
88 ("Action::Action() - option to add "+
89 std::string(optioniter->first)+
90 " of Action "+
91 std::string(getName())+
92 " is already present with different short form: "
93 +PresentOption->getShortForm()+" != "+optioniter->second->getShortForm()
94 )
95 );
96 }
97 }
98}
99
100Action::~Action()
101{}
102
103const string Action::getName() const
104{
105 return Traits.getName();
106}
107
108const std::string Action::help() const
109{
110 std::stringstream outputstream;
111 outputstream << "Description for Action '" << getName() << "': " << Traits.getDescription()
112 << std::endl;
113 if (!Traits.hasOption(getName())) {
114 outputstream << "\tNote that this Action does not take an argument." << std::endl;
115 }
116 outputstream << "Options available for action '" << getName() << "':" << std::endl;
117 for (ActionTraits::options_const_iterator iter = Traits.getBeginIter();
118 iter != Traits.getEndIter();
119 ++iter) {
120 outputstream << "Option '" << iter->first << "':" << std::endl;
121 outputstream << "\tDescription: " << iter->second->getDescription() << "." << std::endl;
122 outputstream << "\tArgument's type: " << iter->second->getTypeName() << "." << std::endl;
123 outputstream << "\tDefault value: ";
124 if (iter->second->hasDefaultValue()) {
125 outputstream << "Yes, is '" << iter->second->getDefaultValue() << "'";
126 } else {
127 outputstream << "None";
128 }
129 outputstream << "." << std::endl;
130 }
131
132 return outputstream.str();
133}
134
135void Action::removeStaticStateEntities()
136{
137 success.reset();
138 failure.reset();
139}
140
141Dialog * Action::createDialog(){
142 Dialog *dialog = UIFactory::getInstance().makeDialog();
143 return fillDialog(dialog);
144}
145
146void Action::call(enum QueryOptions flag){
147 if(!isActive()){
148 return;
149 }
150 // forward to private virtual
151 if (flag == Interactive) {
152 Dialog* dialog = createDialog();
153 if (dialog->hasQueries()) {
154 dialog->display();
155 }
156 delete(dialog);
157 }
158 state_ptr state = Action::failure;
159// try {
160 state = performCall();
161// } catch(MissingValueException&) {
162// DoeLog(0) && (eLog() << Verbose(0) << "There is a value missing for action " << getName() << endl);
163// };
164
165 if(shouldUndo() && state != failure){
166 if(canUndo()){
167 ActionHistory::getInstance().addElement(this,state);
168 }
169 else{
170 ActionHistory::getInstance().clear();
171 }
172 }
173}
174Action::state_ptr Action::undo(state_ptr _state) {
175 // forward to private virtual
176 return performUndo(_state);
177}
178Action::state_ptr Action::redo(state_ptr _state) {
179 // forward to private virtual
180 return performRedo(_state);
181}
182
183
184bool Action::isActive(){
185 return true;
186}
187
Note: See TracBrowser for help on using the repository browser.