2 * ModuleBase_Operation.h
4 * Created on: Apr 2, 2014
9 #ifndef ModuleBase_Operation_H
10 #define ModuleBase_Operation_H
12 #include <ModuleBase.h>
13 #include <ModuleBase_IOperation.h>
15 #include "ModelAPI_Feature.h"
20 #include <boost/shared_ptr.hpp>
22 class ModelAPI_Document;
27 \class ModuleBase_Operation
28 * \brief Base class for all operations
30 * Base class for all operations. If you perform an action it is reasonable to create
31 * operation intended for this. This is a base class for all operations which provides
32 * mechanism for correct starting operations, starting operations above already started
33 * ones, committing operations and so on. To create own operation it is reasonable to
34 * inherit it from this class and redefines virtual methods to provide own behavior
35 * Main virtual methods are
36 * - virtual bool isReadyToStart();
37 * - virtual void startOperation();
38 * - virtual void abortOperation();
39 * - virtual void commitOperation();
42 class MODULEBASE_EXPORT ModuleBase_Operation: public ModuleBase_IOperation
48 /// \param theId the operation identifier
49 /// \param theParent the QObject parent
50 ModuleBase_Operation(const QString& theId = "", QObject* theParent = 0);
52 virtual ~ModuleBase_Operation();
54 // Returns operations Id from it's description
56 /// Returns the operation feature
57 /// \return the feature
58 FeaturePtr feature() const;
60 /// Returns whether the nested operations are enabled.
61 /// The state can depend on the operation current state.
62 /// \return enabled state
63 virtual bool isNestedOperationsEnabled() const;
65 // Data model methods.
66 /// Stores a custom value in model.
67 void storeCustomValue();
69 virtual void keyReleased(std::string theName, QKeyEvent* theEvent) {};
71 /// Sets the operation feature
72 void setEditingFeature(FeaturePtr theFeature);
74 bool isEditOperation() const { return myIsEditing; }
77 /// Virtual method called when operation started (see start() method for more description)
78 /// Default impl calls corresponding slot and commits immediately.
79 virtual void startOperation();
80 /// Virtual method called when operation stopped - committed or aborted.
81 virtual void stopOperation();
82 /// Virtual method called when operation aborted (see abort() method for more description)
83 virtual void abortOperation();
84 /// Virtual method called when operation committed (see commit() method for more description)
85 virtual void commitOperation();
86 /// Virtual method called after operation committed (see commit() method for more description)
87 virtual void afterCommitOperation();
89 /// Send update message by loop
91 /// Send created message by loop
94 /// Creates an operation new feature
95 /// \param theFlushMessage the flag whether the create message should be flushed
96 /// \returns the created feature
97 virtual FeaturePtr createFeature(const bool theFlushMessage = true);
99 /// Sets the operation feature
100 void setFeature(FeaturePtr theFeature);
103 FeaturePtr myFeature; /// the operation feature to be handled