source: src/Actions/ActionSequence.hpp@ 07d4b1

AutomationFragmentation_failures Candidate_v1.6.1 Candidate_v1.7.0 ChemicalSpaceEvaluator Exclude_Hydrogens_annealWithBondGraph ForceAnnealing_with_BondGraph ForceAnnealing_with_BondGraph_contraction-expansion Gui_displays_atomic_force_velocity PythonUI_with_named_parameters StoppableMakroAction TremoloParser_IncreasedPrecision stable
Last change on this file since 07d4b1 was 10aee4, checked in by Frederik Heber <heber@…>, 10 years ago

Cleaned up ActionQueue's interface: Actions are always cloned.

  • Action's dstor needs to be public as we have a clone() function.
  • ActionRegistrys' (and AQ's) getActionByName now returns const ref. We must not return a ptr as it may not get deleted elsewhere. We are handing out prototypes.
  • queueAction(action*,...) is private to prevent leakage, queueAction(string, ...) is the public interface.
  • some other small functions are now private, too.
  • MakroActions now need to clone() the prototype on prepare() and delete them on unprepare().
  • ActionSequence deletes contained actions.
  • FIX: ActionSequenceUnitTest cannot check on not-called property of removed actions anymore as these are gone now (they are deleted on removal and they are cloned on insertion).
  • DOCU: Updated documentation on Actions.
  • Property mode set to 100644
File size: 1.6 KB
RevLine 
[a5041ec]1/*
[10aee4]2 * ActionSequence.hpp
[a5041ec]3 *
4 * Created on: Dec 17, 2009
5 * Author: crueger
6 */
7
8#ifndef ACTIONSEQUENZE_HPP_
9#define ACTIONSEQUENZE_HPP_
10
[56f73b]11// include config.h
12#ifdef HAVE_CONFIG_H
13#include <config.h>
14#endif
15
16
[5b0b98]17#include "Actions/Action.hpp"
[a5041ec]18
[5b0b98]19#include <deque>
[a5041ec]20
[c1d837]21class ActionSequenceTest;
22
[ce7fdc]23namespace MoleCuilder {
24
[a5041ec]25/**
26 * Store Actions for later use.
27 */
28class ActionSequence
29{
[2efa90]30 friend class MakroAction;
[c1d837]31 //!> grant unit test access to private sequence
32 friend class ::ActionSequenceTest;
[a5041ec]33public:
[67e2b3]34 typedef std::deque<Action*> actionSet;
[b5b01e]35 typedef std::deque<ActionState::ptr> stateSet;
[67e2b3]36
[a5041ec]37 ActionSequence();
[af5384]38 ActionSequence(const ActionSequence &_other);
[a5041ec]39 virtual ~ActionSequence();
40
41 void addAction(Action*);
42 Action* removeLastAction();
[9c1324]43 unsigned int getLoop() const
44 { return loop; }
[a5041ec]45
[2efa90]46 void callAll();
[a5041ec]47
48 bool canUndo();
[67e2b3]49 bool shouldUndo();
[a5041ec]50
[46b181]51 void outputAsCLI(std::ostream &ost) const;
[477012]52 void outputAsPython(std::ostream &ost, const std::string &prefix) const;
[a82f61]53 void setOptionValue(const std::string &_token, const std::string &_value);
[46b181]54
[2efa90]55protected:
[237f93]56 /** removes the first occurence of an action name \a name from sequence.
57 *
58 * \param name name of action
59 * \return true - action removed, false - action not found
60 */
61 bool removeAction(const std::string &name);
62
[2efa90]63 stateSet callAll(bool); // Dummy parameter to allow overloading
[047878]64 Dialog* fillAllDialogs(Dialog *dialog);
[2efa90]65 stateSet undoAll(stateSet);
66 stateSet redoAll(stateSet);
[9c1324]67 void setLoop(unsigned int _loop)
68 { loop = _loop; }
[a5041ec]69private:
[67e2b3]70 actionSet actions;
[9c1324]71 //!> how often the sequence is repeated
72 unsigned int loop;
[a5041ec]73};
74
[ce7fdc]75}
76
[a5041ec]77#endif /* ACTIONSEQUENZE_HPP_ */
Note: See TracBrowser for help on using the repository browser.