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

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

Actions now get ptr to ActionRegistry in cstor.

  • this is the last of the externally present getActionRegistry() calls.
  • also changed: Calculation, ErrorAction, ManipulateAtomsProcess, MakroAction, MethodAction, Process, Reaction. Some of these had default of doRegister but are only used with false. We removed any default value in header if set to true. However, this will cause default behavior of false (as Action has default NULL for ActionRegistry ptr).
  • purged some unnecessary ActionRegistry includes.
  • Property mode set to 100644
File size: 7.0 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/ActionHistory.hpp"
44#include "Actions/ActionRegistry.hpp"
45#include "Actions/OptionRegistry.hpp"
46#include "Actions/OptionTrait.hpp"
47#include "UIElements/Dialog.hpp"
48#include "CodePatterns/Assert.hpp"
49#include "CodePatterns/MemDebug.hpp"
50#include "UIElements/UIFactory.hpp"
51
52#include "CodePatterns/Log.hpp"
53#include "CodePatterns/Verbose.hpp"
54
55using namespace MoleCuilder;
56
57Action::state_ptr getEmptyState() {
58 return Action::state_ptr(Memory::ignore(new ActionState()));
59}
60
61void Action::removeStaticStateEntities()
62{
63 Action::success.reset();
64 Action::failure.reset();
65}
66
67void Action::createStaticStateEntities()
68{
69 Action::success = getEmptyState();
70 Action::failure = getEmptyState();
71}
72
73// An empty state to indicate success, these are (de)initialized by ActionHistory
74Action::state_ptr Action::success;
75Action::state_ptr Action::failure;
76
77Action::Action(const ActionTrait &_Traits, ActionRegistry * const _AR) :
78 Traits(_Traits),
79 AR(_AR)
80{
81 // register with ActionRegistry
82 if(AR != NULL) {
83 AR->registerInstance(this);
84 }
85
86 // register with OptionRegistry
87 for (ActionTrait::options_const_iterator optioniter = Traits.getBeginIter();
88 optioniter != Traits.getEndIter();
89 ++optioniter) {
90 // options may have been re-used by other Actions, so check beforehand whether adding is needed
91 if (!OptionRegistry::getInstance().isOptionPresentByName((optioniter->first))) {
92 OptionRegistry::getInstance().registerInstance(optioniter->second);
93 } else { // if present, ASSERT that types coincide
94#ifndef NDEBUG
95 OptionTrait const * const PresentOption = OptionRegistry::getInstance().getOptionByName(optioniter->first);
96#endif
97 ASSERT(PresentOption->getType() == optioniter->second->getType(),
98 ("Action::Action() - option to add "+
99 std::string(optioniter->first)+
100 " of Action "+
101 std::string(getName())+
102 " is already present with different type: "
103 +toString(PresentOption->getType())+" != "+toString(optioniter->second->getType())
104 )
105 );
106 ASSERT(PresentOption->getDefaultValue() == optioniter->second->getDefaultValue(),
107 ("Action::Action() - option to add "+
108 std::string(optioniter->first)+
109 " of Action "+
110 std::string(getName())+
111 " is already present with different default value: "
112 +PresentOption->getDefaultValue()+" != "+optioniter->second->getDefaultValue()
113 )
114 );
115 ASSERT(PresentOption->getShortForm() == optioniter->second->getShortForm(),
116 ("Action::Action() - option to add "+
117 std::string(optioniter->first)+
118 " of Action "+
119 std::string(getName())+
120 " is already present with different short form: "
121 +PresentOption->getShortForm()+" != "+optioniter->second->getShortForm()
122 )
123 );
124 }
125 }
126}
127
128Action::~Action()
129{
130 // unregister us if still registered
131 if (AR != NULL)
132 AR->unregisterInstance(this);
133
134 for (ActionTrait::options_const_iterator optioniter = Traits.getBeginIter();
135 optioniter != Traits.getEndIter();
136 ++optioniter) {
137 // unregister option if still registered
138 if(OptionRegistry::getInstance().isOptionPresentByName((optioniter->first)))
139 if (OptionRegistry::getInstance().getOptionByName((optioniter->first)) == optioniter->second) {
140 OptionRegistry::getInstance().unregisterInstance(optioniter->second);
141 }
142 }
143}
144
145const string Action::getName() const
146{
147 return Traits.getName();
148}
149
150const std::string Action::help() const
151{
152 std::stringstream outputstream;
153 outputstream << "Description for Action '" << getName() << "': " << Traits.getDescription()
154 << std::endl;
155 if (!Traits.hasOption(getName())) {
156 outputstream << "\tNote that this Action does not take an argument." << std::endl;
157 }
158 outputstream << "Options available for action '" << getName() << "':" << std::endl;
159 for (ActionTrait::options_const_iterator iter = Traits.getBeginIter();
160 iter != Traits.getEndIter();
161 ++iter) {
162 outputstream << "Option '" << iter->first << "':" << std::endl;
163 outputstream << "\tDescription: " << iter->second->getDescription() << "." << std::endl;
164 outputstream << "\tArgument's type: " << iter->second->getTypeName() << "." << std::endl;
165 outputstream << "\tDefault value: ";
166 if (iter->second->hasDefaultValue()) {
167 outputstream << "Yes, is '" << iter->second->getDefaultValue() << "'";
168 } else {
169 outputstream << "None";
170 }
171 outputstream << "." << std::endl;
172 }
173
174 return outputstream.str();
175}
176
177Dialog * Action::createDialog(){
178 Dialog *dialog = UIFactory::getInstance().makeDialog();
179 return fillDialog(dialog);
180}
181
182void Action::call(enum QueryOptions flag){
183 if(!isActive()){
184 return;
185 }
186 // forward to private virtual
187 if (flag == Interactive) {
188 Dialog* dialog = createDialog();
189 if (dialog->hasQueries()) {
190 if (!dialog->display())
191 // dialog error or aborted -> throw exception
192 throw ActionFailureException() << ActionNameString(getName());
193 }
194 delete(dialog);
195 }
196 state_ptr state = Action::failure;
197// try {
198 startTimer();
199 state = performCall();
200 endTimer();
201// } catch(MissingValueException&) {
202// ELOG(0, "There is a value missing for action " << getName());
203// };
204
205 if(shouldUndo() && state != failure){
206 if(canUndo()){
207 ActionHistory::getInstance().addElement(this,state);
208 }
209 else{
210 ActionHistory::getInstance().clear();
211 }
212 }
213
214 // throw an exception that can be caught in case of failure
215 if (state == Action::failure)
216 throw ActionFailureException() << ActionNameString(getName());
217}
218Action::state_ptr Action::undo(state_ptr _state) {
219 // forward to private virtual
220 return performUndo(_state);
221}
222Action::state_ptr Action::redo(state_ptr _state) {
223 // forward to private virtual
224 return performRedo(_state);
225}
226
227
228bool Action::isActive(){
229 return true;
230}
231
Note: See TracBrowser for help on using the repository browser.