| 1 | /*
|
|---|
| 2 | * MakroAction.hpp
|
|---|
| 3 | *
|
|---|
| 4 | * Created on: Dec 17, 2009
|
|---|
| 5 | * Author: crueger
|
|---|
| 6 | */
|
|---|
| 7 |
|
|---|
| 8 | #ifndef MAKROACTION_HPP_
|
|---|
| 9 | #define MAKROACTION_HPP_
|
|---|
| 10 |
|
|---|
| 11 | // include config.h
|
|---|
| 12 | #ifdef HAVE_CONFIG_H
|
|---|
| 13 | #include <config.h>
|
|---|
| 14 | #endif
|
|---|
| 15 |
|
|---|
| 16 |
|
|---|
| 17 | #include <string>
|
|---|
| 18 |
|
|---|
| 19 | #include "Actions/Action.hpp"
|
|---|
| 20 | #include "Actions/ActionSequence.hpp"
|
|---|
| 21 |
|
|---|
| 22 | class ActionSequenceTest;
|
|---|
| 23 |
|
|---|
| 24 | namespace MoleCuilder {
|
|---|
| 25 | class ActionRegistry;
|
|---|
| 26 |
|
|---|
| 27 | /**
|
|---|
| 28 | * Action to allow producing bigger Actions from sequences of small actions.
|
|---|
| 29 | *
|
|---|
| 30 | * Destruction of the Actions and the sequence is handled by this class.
|
|---|
| 31 | */
|
|---|
| 32 | class MakroAction : public Action
|
|---|
| 33 | {
|
|---|
| 34 | //!> grant unit test access to sequence
|
|---|
| 35 | friend class ::ActionSequenceTest;
|
|---|
| 36 | public:
|
|---|
| 37 | MakroAction(const MakroAction &_instance);
|
|---|
| 38 | MakroAction(const ActionTrait &_trait,ActionSequence& _actions);
|
|---|
| 39 |
|
|---|
| 40 | bool canUndo();
|
|---|
| 41 | bool shouldUndo();
|
|---|
| 42 |
|
|---|
| 43 | virtual Action* clone(enum QueryOptions flag = Interactive) const;
|
|---|
| 44 | void prepare(enum QueryOptions flag = Interactive);
|
|---|
| 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 | // must be called after all primitive actions are present
|
|---|
| 52 | virtual void prepare(ActionRegistry &AR);
|
|---|
| 53 | // must be called before alle primitive actions are removed
|
|---|
| 54 | virtual void unprepare(ActionRegistry &AR);
|
|---|
| 55 |
|
|---|
| 56 | void setLoop(unsigned int _loop);
|
|---|
| 57 |
|
|---|
| 58 | unsigned int getLoop() const;
|
|---|
| 59 |
|
|---|
| 60 | unsigned int getStep() const;
|
|---|
| 61 |
|
|---|
| 62 | protected:
|
|---|
| 63 | virtual ~MakroAction();
|
|---|
| 64 |
|
|---|
| 65 | /**
|
|---|
| 66 | * MakroAction requires an own dialog for global options such as number of loop
|
|---|
| 67 | * iterations, ... besides the dialog from each action in the sequence.
|
|---|
| 68 | *
|
|---|
| 69 | * However, fillDialog() calls ActionSequence::fillAllDialog(). Hence, the dialog
|
|---|
| 70 | * for specific global options must be requested in an distinct function.
|
|---|
| 71 | */
|
|---|
| 72 | virtual Dialog * fillOwnDialog(Dialog*);
|
|---|
| 73 |
|
|---|
| 74 | /** Pass-thru for removeAction to allow all derived MakroActions to manipulate action sequence.
|
|---|
| 75 | *
|
|---|
| 76 | * \param name name of action to remove
|
|---|
| 77 | * \return true - action removed, false - action not found
|
|---|
| 78 | * \sa ActionSequence::removeAction()
|
|---|
| 79 | */
|
|---|
| 80 | bool removeAction(const std::string &name);
|
|---|
| 81 |
|
|---|
| 82 | virtual ActionState::ptr performCall();
|
|---|
| 83 | virtual ActionState::ptr performUndo(ActionState::ptr);
|
|---|
| 84 | virtual ActionState::ptr performRedo(ActionState::ptr);
|
|---|
| 85 |
|
|---|
| 86 | private:
|
|---|
| 87 | /** fillDialog is used to spawn sequence queries, hence must not be modified by
|
|---|
| 88 | * derived MakroActions.
|
|---|
| 89 | */
|
|---|
| 90 | Dialog *fillDialog(Dialog *dialog);
|
|---|
| 91 |
|
|---|
| 92 | //!> this points to the instance of a specific MakroAction, we need to ref for callAll()
|
|---|
| 93 | ActionSequence &actions;
|
|---|
| 94 | };
|
|---|
| 95 |
|
|---|
| 96 | }
|
|---|
| 97 |
|
|---|
| 98 | #endif /* MAKROACTION_HPP_ */
|
|---|
