src/ModelAPI/ModelAPI_Events.h

   1 // File:        ModelAPI_Events.h
   2 // Created:     10 Apr 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #ifndef ModelAPI_Events_H_
   6 #define ModelAPI_Events_H_
   7
   8 #include <ModelAPI.h>
   9 #include <Events_MessageGroup.h>
  10 #include <boost/shared_ptr.hpp>
  11 #include <string>
  12 #include <set>
  13
  14 #include "ModelAPI_Object.h"
  15
  16 class ModelAPI_Document;
  17
  18 /// Event ID that feature is created (comes with ModelAPI_ObjectUpdatedMessage)
  19 static const char * EVENT_OBJECT_CREATED = "ObjectCreated";
  20 /// Event ID that data of feature is updated (comes with Model_ObjectUpdatedMessage)
  21 static const char * EVENT_OBJECT_UPDATED = "ObjectUpdated";
  22 /// Event ID that data of feature is deleted (comes with Model_ObjectDeletedMessage)
  23 static const char * EVENT_OBJECT_DELETED = "ObjectDeleted";
  24 /// Event ID that data of feature is updated (comes with ModelAPI_ObjectUpdatedMessage)
  25 static const char * EVENT_OBJECT_MOVED = "ObjectsMoved";
  26 /// Event ID that visualization must be redisplayed (comes with ModelAPI_ObjectUpdatedMessage)
  27 static const char * EVENT_OBJECT_TO_REDISPLAY = "ObjectsToRedisplay";
  28 /// Event ID that visualization must be redisplayed (comes with ModelAPI_ObjectUpdatedMessage)
  29 static const char * EVENT_OPERATION_LAUNCHED = "OperationLaunched";
  30
  31 /// Message that feature was changed (used for Object Browser update): moved, updated and deleted
  32 class ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup {
  33 protected:
  34   ModelAPI_ObjectUpdatedMessage(const Events_ID theID, const void* theSender = 0)
  35     : Events_MessageGroup(theID, theSender) {}
  36
  37 public:
  38   /// Returns the feature that has been updated
  39   virtual std::set<ObjectPtr> objects() const = 0;
  40
  41   //! Creates a new empty group (to store it in the loop before flush)
  42   virtual Events_MessageGroup* newEmpty() = 0;
  43
  44   //! Allows to join the given message with the current one
  45   virtual void Join(Events_MessageGroup& theJoined) = 0;
  46 };
  47
  48 /// Message that feature was deleted (used for Object Browser update)
  49 class ModelAPI_ObjectDeletedMessage : public Events_MessageGroup {
  50 protected:
  51   ModelAPI_ObjectDeletedMessage(const Events_ID theID, const void* theSender = 0)
  52     : Events_MessageGroup(theID, theSender) {}
  53
  54 public:
  55   /// Returns the feature that has been updated
  56   virtual boost::shared_ptr<ModelAPI_Document> document() const = 0;
  57
  58   /// Returns the group where the feature was deleted
  59   virtual const std::set<std::string >& groups() const = 0;
  60
  61   virtual Events_MessageGroup* newEmpty() = 0;
  62
  63   virtual const Events_ID messageId() = 0;
  64
  65   virtual void Join(Events_MessageGroup& theJoined) = 0;
  66 };
  67
  68 /// Allows to create ModelAPI messages
  69 class MODELAPI_EXPORT ModelAPI_EventCreator {
  70 public:
  71   /// creates created, updated or moved messages and sends to the loop
  72   virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent,
  73                            const bool isGroupped = true) const = 0;
  74   /// creates deleted message and sends to the loop
  75   virtual void sendDeleted(
  76     const boost::shared_ptr<ModelAPI_Document>& theDoc, const std::string& theGroup) const = 0;
  77
  78   /// returns the creator instance
  79   static const ModelAPI_EventCreator* get();
  80
  81   /// sets the creator instance
  82   static void set(const ModelAPI_EventCreator* theCreator);
  83 };
  84
  85 #endif