src/ModelAPI/ModelAPI_Events.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModelAPI_Events.h
   4 // Created:     10 Apr 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef MODELAPI_EVENTS_H_
   8 #define MODELAPI_EVENTS_H_
   9
  10 #include <ModelAPI.h>
  11 #include <ModelAPI_Object.h>
  12 #include <ModelAPI_Feature.h>
  13 #include <Events_MessageGroup.h>
  14 #include <Events_Loop.h>
  15
  16 #include <memory>
  17 #include <string>
  18 #include <set>
  19 #include <map>
  20
  21
  22 class ModelAPI_Document;
  23
  24 /// Event ID that feature is created (comes with ModelAPI_ObjectUpdatedMessage)
  25 static const char * EVENT_OBJECT_CREATED = "ObjectCreated";
  26 /// Event ID that data of feature is updated (comes with Model_ObjectUpdatedMessage)
  27 static const char * EVENT_OBJECT_UPDATED = "ObjectUpdated";
  28 /// Event ID that data of feature is deleted (comes with Model_ObjectDeletedMessage)
  29 static const char * EVENT_OBJECT_DELETED = "ObjectDeleted";
  30 /// Event ID that data of feature is updated (comes with ModelAPI_ObjectUpdatedMessage)
  31 static const char * EVENT_OBJECT_MOVED = "ObjectsMoved";
  32 /// Event ID that visualization must be redisplayed (comes with ModelAPI_ObjectUpdatedMessage)
  33 static const char * EVENT_OBJECT_TO_REDISPLAY = "ObjectsToRedisplay";
  34 /// Event ID that visualization must be redisplayed (comes with ModelAPI_ObjectUpdatedMessage)
  35 static const char * EVENT_OPERATION_LAUNCHED = "OperationLaunched";
  36 /// Event ID that plugin is loaded (comes with ModelAPI_ObjectUpdatedMessage)
  37 static const char * EVENT_PLUGIN_LOADED = "PliginLoaded";
  38 /// Event ID that data of feature has to be shown (comes with ModelAPI_ObjectUpdatedMessage)
  39 static const char * EVENT_OBJECT_TOSHOW = "ObjectShow";
  40 /// Event ID that data of feature has to be shown (comes with ModelAPI_ObjectUpdatedMessage)
  41 static const char * EVENT_OBJECT_TOHIDE = "ObjectHide";
  42 //
  43 static const char * EVENT_DOCUMENT_CHANGED = "CurrentDocumentChanged";
  44
  45 static const char * EVENT_FEATURE_STATE_REQUEST = "FeatureStateRequest";
  46 static const char * EVENT_FEATURE_STATE_RESPONSE = "FeatureStateResponse";
  47
  48 /// Message that feature was changed (used for Object Browser update): moved, updated and deleted
  49 class MODELAPI_EXPORT ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup
  50 {
  51  protected:
  52   /// Creates an empty message
  53   ModelAPI_ObjectUpdatedMessage(const Events_ID theID, const void* theSender = 0);
  54   /// The virtual destructor
  55   virtual ~ModelAPI_ObjectUpdatedMessage();
  56
  57  public:
  58   /// Returns the feature that has been updated
  59   virtual const std::set<ObjectPtr>& objects() const = 0;
  60
  61   //! Creates a new empty group (to store it in the loop before flush)
  62   virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
  63
  64   //! Allows to join the given message with the current one
  65   virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
  66 };
  67
  68 /// Message that feature was deleted (used for Object Browser update)
  69 class MODELAPI_EXPORT ModelAPI_ObjectDeletedMessage : public Events_MessageGroup
  70 {
  71 protected:
  72   /// Creates an empty message
  73   ModelAPI_ObjectDeletedMessage(const Events_ID theID, const void* theSender = 0);
  74   /// The virtual destructor
  75   virtual ~ModelAPI_ObjectDeletedMessage();
  76
  77 public:
  78   /// Returns the feature that has been updated
  79   virtual std::shared_ptr<ModelAPI_Document> document() const = 0;
  80
  81   /// Returns the group where the feature was deleted
  82   virtual const std::set<std::string>& groups() const = 0;
  83
  84   /// Creates the new empty message of this kind
  85   virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
  86
  87   /// Returns the identifier of the kind of a message
  88   virtual const Events_ID messageId() = 0;
  89
  90   /// Appenad to this message the given one.
  91   virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
  92 };
  93
  94 /// Allows to create ModelAPI messages
  95 class MODELAPI_EXPORT ModelAPI_EventCreator
  96 {
  97 public:
  98   /// creates created, updated or moved messages and sends to the loop
  99   virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent,
 100                            const bool isGroupped = true) const = 0;
 101   /// creates deleted message and sends to the loop
 102   virtual void sendDeleted(const std::shared_ptr<ModelAPI_Document>& theDoc,
 103                            const std::string& theGroup) const = 0;
 104
 105   /// returns the creator instance
 106   static const ModelAPI_EventCreator* get();
 107
 108   /// sets the creator instance
 109   static void set(const ModelAPI_EventCreator* theCreator);
 110 };
 111
 112 // TODO(sbh): Move this message into a separate package, like "GuiAPI"
 113 /// Contains the state information about the feature: is it enabled or disabled.
 114 class ModelAPI_FeatureStateMessage : public Events_Message
 115 {
 116 public:
 117   /// Creates an empty message
 118   MODELAPI_EXPORT ModelAPI_FeatureStateMessage(const Events_ID theID, const void* theSender = 0);
 119   /// The virtual destructor
 120   MODELAPI_EXPORT virtual ~ModelAPI_FeatureStateMessage();
 121
 122   /// Returns the feature this message is related to
 123   MODELAPI_EXPORT std::shared_ptr<ModelAPI_Feature> feature() const;
 124   /// Stores the feature this message is related to
 125   MODELAPI_EXPORT void setFeature(std::shared_ptr<ModelAPI_Feature>& theFeature);
 126   // For response
 127   /// Returns true if feature has specific state
 128   MODELAPI_EXPORT bool hasState(const std::string& theFeatureId) const;
 129   /// Returns true if feature is enabled
 130   MODELAPI_EXPORT bool state(const  std::string& theFeatureId, bool theDefault = false) const;
 131   /// Stores the feature state
 132   MODELAPI_EXPORT void setState(const std::string& theFeatureId, bool theValue);
 133   /// Returns all feature IDs with states
 134   MODELAPI_EXPORT std::list<std::string> features() const;
 135
 136  private:
 137   /// For Request
 138   std::shared_ptr<ModelAPI_Feature> myCurrentFeature;
 139   /// For response
 140   std::map<std::string, bool> myFeatureState;
 141 };
 142
 143 /// Message that document (Part, PartSet) was created
 144 class ModelAPI_DocumentCreatedMessage : public Events_Message
 145 {
 146   DocumentPtr myDocument;
 147
 148  public:
 149   /// Creates an empty message
 150   MODELAPI_EXPORT ModelAPI_DocumentCreatedMessage(const Events_ID theID, const void* theSender = 0);
 151   /// The virtual destructor
 152   MODELAPI_EXPORT virtual ~ModelAPI_DocumentCreatedMessage();
 153
 154   MODELAPI_EXPORT static Events_ID eventId()
 155   {
 156     static const char * MY_DOCUMENT_CREATED_EVENT_ID("DocumentCreated");
 157     return Events_Loop::eventByName(MY_DOCUMENT_CREATED_EVENT_ID);
 158   }
 159
 160
 161   MODELAPI_EXPORT DocumentPtr document() const;
 162   MODELAPI_EXPORT void setDocument(DocumentPtr theDocument);
 163 };
 164
 165 #endif