X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FXGUI%2FXGUI_OperationMgr.h;h=41323570ec46fc3e6fcf12566182c9c84e0e48a6;hb=25df988cd1b0b85f45355f2c21c2642cd0ea1d74;hp=4fabac82118e340dbf2c05d223a7a71716969e06;hpb=c80e8ac643930b858f4f653e2659896ba587b165;p=modules%2Fshaper.git

diff --git a/src/XGUI/XGUI_OperationMgr.h b/src/XGUI/XGUI_OperationMgr.h
index 4fabac821..41323570e 100644
--- a/src/XGUI/XGUI_OperationMgr.h
+++ b/src/XGUI/XGUI_OperationMgr.h
@@ -1,3 +1,7 @@
+// File:        XGUI_OperationMgr.h
+// Created:     20 Apr 2014
+// Author:      Natalia ERMOLAEVA
+
 #ifndef XGUI_OperationMgr_H
 #define XGUI_OperationMgr_H
 
@@ -11,33 +15,69 @@
 /**\class XGUI_OperationMgr
  * \ingroup GUI
  * \brief Operation manager. Servers to manupulate to the workshop operations. Contains a stack
- *   of started operations and uses the upper one as a current.
+ * of started operations. In simple case, if only one operration is started, the stack contains
+ * one operation. It is possible for some kind of operations to start them above already
+ * started one. In that case, the previous active operation becames suspended, a new one - active.
+ * The new operation is added to the top of the stack. Then it is finished, it is removed from
+ * the stack and the previous operation is activated.
  */
 class XGUI_EXPORT XGUI_OperationMgr : public QObject
 {
   Q_OBJECT
 public:
+  /// Constructor
+  /// \param theParent the parent
   XGUI_OperationMgr(QObject* theParent);
+  /// Destructor
   virtual ~XGUI_OperationMgr();
 
+  /// Returns the current operation or NULL
+  /// \return the current operation
   ModuleBase_Operation* currentOperation() const;
+  /// Returns true is operation manager has at least one non-null operation.
+  bool hasOperation() const;
+  /// Returns number of operations in the stack
+  int operationsCount() const;
+  /// Start the operation and append it to the stack of operations
+  /// \param theOperation the started operation
+  /// \return the state whether the current operation is started
   bool startOperation(ModuleBase_Operation* theOperation);
 
-  void commitCurrentOperation();
+  /// Abort the operation and append it to the stack of operations
+  /// \return the state whether the current operation is aborted
+  bool abortOperation();
 
 signals:
-  void beforeOperationStart();
-  void afterOperationStart();
+  /// Signal about an operation is started. It is emitted after the start() of operation is done.
+  void operationStarted();
+  /// Signal about an operation is stopped. It is emitted after the stop() of operation is done.
+  /// \param theOperation a stopped operation
+  void operationStopped(ModuleBase_Operation* theOperation);
 
 protected:
+  /// Sets the current operation or NULL
+  /// \param theOperation the started operation
+  /// \param isCheckBeforeStart the flag whether to check whether the operation can be started
+  /// \return the state whether the operation is resumed
+  void resumeOperation(ModuleBase_Operation* theOperation);
+
+  /// Returns whether the operation can be started. Check if there is already started operation and
+  /// the granted parameter of the launched operation
+  /// \param theOperation an operation to check
   bool canStartOperation(ModuleBase_Operation* theOperation);
 
+  /// Returns whether the operation can be stopped.
+  bool canStopOperation();
+
 protected slots:
+  /// Slot that is called by an operation stop. Removes the stopped operation form the stack.
+  /// If there is a suspended operation, restart it.
   void onOperationStopped();
 
 private:
-  typedef QList<ModuleBase_Operation*> Operations;
-  Operations myOperations;
+  typedef QList<ModuleBase_Operation*> Operations; ///< definition for a list of operations
+  Operations myOperations; ///< a stack of started operations. The active operation is on top,
+                           // others are suspended and started by the active is finished
 };
 
 #endif