| 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 |
|
|---|
| 18 | namespace MoleCuilder {
|
|---|
| 19 |
|
|---|
| 20 | class 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 | */
|
|---|
| 28 | template<typename T>
|
|---|
| 29 | class Calculation : public Process
|
|---|
| 30 | {
|
|---|
| 31 | public:
|
|---|
| 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 | virtual void setOptionValue(const std::string &_token, const std::string &_value);
|
|---|
| 50 |
|
|---|
| 51 | /**
|
|---|
| 52 | * Does the actual calculation and returns the result.
|
|---|
| 53 | * When the calculation has been done before it is not redone, but the previous cached result is returned.
|
|---|
| 54 | * Call reset to delete the cached value.
|
|---|
| 55 | */
|
|---|
| 56 | virtual T operator()();
|
|---|
| 57 |
|
|---|
| 58 | /**
|
|---|
| 59 | * Check if a cached result is available.
|
|---|
| 60 | */
|
|---|
| 61 | virtual bool hasResult() const;
|
|---|
| 62 |
|
|---|
| 63 | /**
|
|---|
| 64 | * Get the cached result.
|
|---|
| 65 | * Fails if there is no cached result.
|
|---|
| 66 | */
|
|---|
| 67 | virtual T getResult() const;
|
|---|
| 68 |
|
|---|
| 69 | /**
|
|---|
| 70 | * Delete a previously calculated result from the cache.
|
|---|
| 71 | */
|
|---|
| 72 | virtual void reset();
|
|---|
| 73 |
|
|---|
| 74 | protected:
|
|---|
| 75 | T* result;
|
|---|
| 76 |
|
|---|
| 77 | /**
|
|---|
| 78 | * Pure virtual method for implementation of the actual calculation procedure.
|
|---|
| 79 | */
|
|---|
| 80 | virtual T* doCalc()=0;
|
|---|
| 81 | private:
|
|---|
| 82 | virtual ActionState::ptr performCall();
|
|---|
| 83 | virtual ActionState::ptr performUndo(ActionState::ptr);
|
|---|
| 84 | virtual ActionState::ptr performRedo(ActionState::ptr);
|
|---|
| 85 |
|
|---|
| 86 | bool done;
|
|---|
| 87 | };
|
|---|
| 88 |
|
|---|
| 89 | }
|
|---|
| 90 |
|
|---|
| 91 | #endif /* CALCULATION_HPP_ */
|
|---|
