src/ModuleBase/ModuleBase_OperationAction.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 /*
   4  * ModuleBase_OperationAction.h
   5  *
   6  *  Created on: Apr 2, 2014
   7  *      Author: sbh
   8  */
   9
  10 #ifndef ModuleBase_OperationAction_H
  11 #define ModuleBase_OperationAction_H
  12
  13 #include <ModuleBase.h>
  14
  15 #include <ModuleBase_Operation.h>
  16
  17 /*!
  18  * \class ModuleBase_OperationAction
  19  * \ingroup GUI
  20  * \brief Base class for all operations
  21  *
  22  *  Base class for all operations. If you perform an action it is reasonable to create
  23  *  operation intended for this. This is a base class for all operations which provides
  24  *  mechanism for correct starting operations, starting operations above already started
  25  *  ones, committing operations and so on. To create own operation it is reasonable to
  26  *  inherit it from this class and redefines virtual methods to provide own behavior
  27  */
  28
  29 class MODULEBASE_EXPORT ModuleBase_OperationAction : public ModuleBase_Operation
  30 {
  31 Q_OBJECT
  32
  33  public:
  34
  35   /// Constructor
  36   /// \param theId the operation identifier
  37   /// \param theParent the QObject parent
  38   ModuleBase_OperationAction(const QString& theId = "", QObject* theParent = 0);
  39   /// Destructor
  40   virtual ~ModuleBase_OperationAction();
  41 };
  42
  43 #endif