source: src/Actions/Calculation.hpp@ 1ae9aa

Last change on this file since 1ae9aa was af5384, checked in by Frederik Heber <heber@…>, 12 years ago

Actions can now clone() and split off prepare() from call().

  • ActionQueue now separates call phase into clone(), prepare(), and call().
  • ActionQueue's dstor releases Actions in deque.
  • CurrentAction is an index as push_back always invalidates iterator.
  • ActionQueue_t is now a simple vector of ptrs.
  • call() is now non-interactive, (maybe) interactive part is placed in prepare() where dialogs are used to fill parameters.
  • only fully prepared Actions are placed in ActionQueue.
  • ActionQueue obtains action instances from Registry, copies, prepares them, and places them in the queue.
  • Action::clone() gets QueryOptions as param. This lets us either clone without params or really copy the instance.
  • If action is called as COMMAND, params have been filled already.
  • Reactions require a ActionQueue::getLastAction() to actually obtain result of (cloned) Action.
  • FIX: Calculation now has const has...() and getResult().
  • Property mode set to 100644
File size: 2.0 KB
Line 
1/*
2 * Calculation.hpp
3 *
4 * Created on: Feb 19, 2010
5 * Author: crueger
6 */
7
8#ifndef CALCULATION_HPP_
9#define CALCULATION_HPP_
10
11// include config.h
12#ifdef HAVE_CONFIG_H
13#include <config.h>
14#endif
15
16#include "Actions/Process.hpp"
17
18namespace MoleCuilder {
19
20class ActionRegistry;
21
22/**
23 * A calculation is a Process that has some kind of result.
24 *
25 * This class can be used in the same way as any other Action or Process, but has some special methods
26 * for inspecting the result of the calculation.
27 */
28template<typename T>
29class Calculation : public Process
30{
31public:
32 Calculation(int _maxSteps, const ActionTrait &_trait);
33 virtual ~Calculation();
34
35 /**
36 * Reimplemented call method for Action Base class.
37 * Resets the result and then redoes the calculation. Can be used to retrigger calculations
38 * from menu Items or other places.
39 */
40 virtual bool canUndo();
41
42 virtual bool shouldUndo();
43
44 virtual Action* clone(enum QueryOptions flag = Interactive) const=0;
45
46 virtual void outputAsCLI(std::ostream &ost) const;
47 virtual void outputAsPython(std::ostream &ost, const std::string &prefix) const;
48
49 /**
50 * Does the actual calculation and returns the result.
51 * When the calculation has been done before it is not redone, but the previous cached result is returned.
52 * Call reset to delete the cached value.
53 */
54 virtual T operator()();
55
56 /**
57 * Check if a cached result is available.
58 */
59 virtual bool hasResult() const;
60
61 /**
62 * Get the cached result.
63 * Fails if there is no cached result.
64 */
65 virtual T getResult() const;
66
67 /**
68 * Delete a previously calculated result from the cache.
69 */
70 virtual void reset();
71
72protected:
73 T* result;
74
75 /**
76 * Pure virtual method for implementation of the actual calculation procedure.
77 */
78 virtual T* doCalc()=0;
79private:
80 virtual ActionState::ptr performCall();
81 virtual ActionState::ptr performUndo(ActionState::ptr);
82 virtual ActionState::ptr performRedo(ActionState::ptr);
83
84 bool done;
85};
86
87}
88
89#endif /* CALCULATION_HPP_ */
Note: See TracBrowser for help on using the repository browser.