source: src/Actions/Action.cpp@ 0d4168

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

Allow setting of invalid values in Value class, Action::performCall() catches ParameterExceptions.

Value changes:

  • Values are now checked with get().
  • having the Actions fill their parameters on instantiation may lead to invalid values because actions that, e.g. add an atom and thereby make a so far invalid atomic id now valid, still have to get executed.
  • hence, we allow setting of invalid values. Validity is check/enforced on get(), i.e. when the Action is actually performed and not before. This is also the very moment where the parameters are first required to be valid.
  • Parameter::clone() and copy cstor must not use get() as invalid values are there still allowed.
  • TESTFIX: Value behavior changed.
  • TESTFIX: regression test add atom outside boundary is working again.
  • TESTFIX: regression tests load/store-session would be skipped as loading non-present file fails now. We use --help --actionname instead.

Action changes:

  • are turned into Action::failure.
  • ActionQueue calling an Action wrapped in try/catch-block for ActionFailure.
  • removed try/catch in doUI().
  • as exception (will) occur in ActionQueue's queue_thread, we need to catch it there. As the only thing we do is set the exit flag of the World. We can do this in ActionQueue as well.
  • Property mode set to 100644
File size: 4.6 KB
Line 
1/*
2 * Project: MoleCuilder
3 * Description: creates and alters molecular systems
4 * Copyright (C) 2010-2012 University of Bonn. All rights reserved.
5 *
6 *
7 * This file is part of MoleCuilder.
8 *
9 * MoleCuilder is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation, either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * MoleCuilder is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with MoleCuilder. If not, see <http://www.gnu.org/licenses/>.
21 */
22
23/*
24 * Action.cpp
25 *
26 * Created on: Dec 8, 2009
27 * Author: crueger
28 */
29
30// include config.h
31#ifdef HAVE_CONFIG_H
32#include <config.h>
33#endif
34
35#include "CodePatterns/MemDebug.hpp"
36
37#include <iostream>
38#include <sstream>
39#include <string>
40
41#include "Actions/Action.hpp"
42#include "Actions/ActionExceptions.hpp"
43#include "Actions/ActionQueue.hpp"
44#include "Actions/ActionRegistry.hpp"
45#include "UIElements/Dialog.hpp"
46#include "CodePatterns/Assert.hpp"
47#include "CodePatterns/MemDebug.hpp"
48#include "UIElements/UIFactory.hpp"
49
50#include "CodePatterns/Log.hpp"
51#include "CodePatterns/Verbose.hpp"
52
53using namespace MoleCuilder;
54
55ActionState::ptr getEmptyState() {
56 return ActionState::ptr(Memory::ignore(new ActionState()));
57}
58
59void Action::removeStaticStateEntities()
60{
61 Action::success.reset();
62 Action::failure.reset();
63}
64
65void Action::createStaticStateEntities()
66{
67 Action::success = getEmptyState();
68 Action::failure = getEmptyState();
69}
70
71// An empty state to indicate success, these are (de)initialized by ActionHistory
72ActionState::ptr Action::success;
73ActionState::ptr Action::failure;
74
75Action::Action(const ActionTrait &_Traits) :
76 Traits(_Traits)
77{}
78
79Action::~Action()
80{}
81
82const string Action::getName() const
83{
84 return Traits.getName();
85}
86
87const std::string Action::help() const
88{
89 std::stringstream outputstream;
90 outputstream << "Description for Action '" << getName() << "': " << Traits.getDescription()
91 << std::endl;
92 if (!Traits.hasOption(getName())) {
93 outputstream << "\tNote that this Action does not take an argument." << std::endl;
94 }
95 outputstream << "Options available for action '" << getName() << "':" << std::endl;
96 for (ActionTrait::options_const_iterator iter = Traits.getBeginIter();
97 iter != Traits.getEndIter();
98 ++iter) {
99 outputstream << "Option '" << iter->first << "':" << std::endl;
100 outputstream << "\tDescription: " << iter->second->getDescription() << "." << std::endl;
101 outputstream << "\tArgument's type: " << iter->second->getTypeName() << "." << std::endl;
102 outputstream << "\tDefault value: ";
103 if (iter->second->hasDefaultValue()) {
104 outputstream << "Yes, is '" << iter->second->getDefaultValue() << "'";
105 } else {
106 outputstream << "None";
107 }
108 outputstream << "." << std::endl;
109 }
110
111 return outputstream.str();
112}
113
114void Action::prepare(enum QueryOptions flag)
115{
116 // fill with
117 if (flag == Interactive) {
118 Dialog* dialog = createDialog();
119 if (dialog->hasQueries()) {
120 if (!dialog->display())
121 // dialog error or aborted -> throw exception
122 throw ActionFailureException() << ActionNameString(getName());
123 }
124 delete(dialog);
125 }
126}
127
128Dialog * Action::createDialog(){
129 Dialog *dialog = UIFactory::getInstance().makeDialog();
130 return fillDialog(dialog);
131}
132
133void Action::call(){
134 if(!isActive()){
135 return;
136 }
137 ActionState::ptr state = Action::failure;
138 startTimer();
139 try {
140 state = performCall();
141 } catch (ParameterException &e) {
142 if( const std::string *name=boost::get_error_info<ParameterName>(e) )
143 ELOG(1, "The following parameter value is not valid: " << *name << ".");
144 state = Action::failure;
145 }
146 endTimer();
147
148 if(shouldUndo() && state != failure){
149 if(canUndo()){
150 ActionQueue::getInstance().addElement(this,state);
151 }
152 else{
153 ActionQueue::getInstance().clear();
154 }
155 }
156
157 // throw an exception that can be caught in case of failure
158 if (state == Action::failure)
159 throw ActionFailureException() << ActionNameString(getName());
160}
161ActionState::ptr Action::undo(ActionState::ptr _state) {
162 // forward to private virtual
163 return performUndo(_state);
164}
165ActionState::ptr Action::redo(ActionState::ptr _state) {
166 // forward to private virtual
167 return performRedo(_state);
168}
169
170
171bool Action::isActive(){
172 return true;
173}
174
Note: See TracBrowser for help on using the repository browser.