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 <ModelAPI_Attribute.h>
  14 #include <Events_MessageGroup.h>
  15 #include <Events_Loop.h>
  16
  17 #include <memory>
  18 #include <string>
  19 #include <set>
  20 #include <map>
  21
  22
  23 class ModelAPI_Document;
  24
  25 /// Event ID that feature is created (comes with ModelAPI_ObjectUpdatedMessage)
  26 static const char * EVENT_OBJECT_CREATED = "ObjectCreated";
  27 /// Event ID that data of feature is updated (comes with Model_ObjectUpdatedMessage)
  28 static const char * EVENT_OBJECT_UPDATED = "ObjectUpdated";
  29 /// Event ID that data of feature is deleted (comes with Model_ObjectDeletedMessage)
  30 static const char * EVENT_OBJECT_DELETED = "ObjectDeleted";
  31 /// Event ID that name of feature is changed (comes with Model_ObjectRenamedMessage)
  32 static const char * EVENT_OBJECT_RENAMED = "ObjectRenamed";
  33 /// Event ID that data of feature is updated (comes with ModelAPI_ObjectUpdatedMessage)
  34 static const char * EVENT_OBJECT_MOVED = "ObjectsMoved";
  35 /// Event ID that visualization must be redisplayed (comes with ModelAPI_ObjectUpdatedMessage)
  36 static const char * EVENT_OBJECT_TO_REDISPLAY = "ObjectsToRedisplay";
  37 /// Event ID that visualization must be redisplayed (comes with ModelAPI_ObjectUpdatedMessage)
  38 static const char * EVENT_OPERATION_LAUNCHED = "OperationLaunched";
  39 /// Event ID that plugin is loaded (comes with ModelAPI_ObjectUpdatedMessage)
  40 static const char * EVENT_PLUGIN_LOADED = "PliginLoaded";
  41 //
  42 static const char * EVENT_DOCUMENT_CHANGED = "CurrentDocumentChanged";
  43
  44 static const char * EVENT_FEATURE_STATE_REQUEST = "FeatureStateRequest";
  45 static const char * EVENT_FEATURE_STATE_RESPONSE = "FeatureStateResponse";
  46
  47
  48 static const char * EVENT_UPDATE_VIEWER_BLOCKED = "UpdateViewerBlocked";
  49 static const char * EVENT_UPDATE_VIEWER_UNBLOCKED = "UpdateViewerUnblocked";
  50
  51 static const char * EVENT_SOLVER_FAILED = "SolverFailed";
  52 static const char * EVENT_SOLVER_REPAIRED = "SolverRepaired";
  53
  54 /// Event ID that order of objects in group is changed, so, tree must be fully rectreated (movement of feature)
  55 static const char * EVENT_ORDER_UPDATED = "OrderUpdated";
  56
  57 /// Message that feature was changed (used for Object Browser update): moved, updated and deleted
  58 class MODELAPI_EXPORT ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup
  59 {
  60  protected:
  61   /// Creates an empty message
  62   ModelAPI_ObjectUpdatedMessage(const Events_ID theID, const void* theSender = 0);
  63   /// The virtual destructor
  64   virtual ~ModelAPI_ObjectUpdatedMessage();
  65
  66  public:
  67   /// Returns the feature that has been updated
  68   virtual const std::set<ObjectPtr>& objects() const = 0;
  69
  70   //! Creates a new empty group (to store it in the loop before flush)
  71   virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
  72
  73   //! Allows to join the given message with the current one
  74   virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
  75 };
  76
  77 /// Message that feature was deleted (used for Object Browser update)
  78 class MODELAPI_EXPORT ModelAPI_ObjectDeletedMessage : public Events_MessageGroup
  79 {
  80 protected:
  81   /// Creates an empty message
  82   ModelAPI_ObjectDeletedMessage(const Events_ID theID, const void* theSender = 0);
  83   /// The virtual destructor
  84   virtual ~ModelAPI_ObjectDeletedMessage();
  85
  86 public:
  87   /// Returns the document that has been updated
  88   virtual std::shared_ptr<ModelAPI_Document> document() const = 0;
  89
  90   /// Returns the groups where the objects were deleted
  91   virtual const std::set<std::string>& groups() const = 0;
  92
  93   /// Creates the new empty message of this kind
  94   virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
  95
  96   /// Returns the identifier of the kind of a message
  97   virtual const Events_ID messageId() = 0;
  98
  99   /// Appenad to this message the given one.
 100   virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
 101 };
 102
 103 /// Message that order changed (used for Object Browser update)
 104 class MODELAPI_EXPORT ModelAPI_OrderUpdatedMessage : public Events_Message
 105 {
 106 protected:
 107   /// Creates an empty message
 108   ModelAPI_OrderUpdatedMessage(const Events_ID theID, const void* theSender = 0);
 109   /// The virtual destructor
 110   virtual ~ModelAPI_OrderUpdatedMessage();
 111
 112 public:
 113   /// Returns the document that has been updated
 114   virtual std::shared_ptr<ModelAPI_Document> document() const = 0;
 115
 116   /// Returns the groups where the objects were reordered
 117   virtual const std::string& group() const = 0;
 118
 119   /// Returns the identifier of the kind of a message
 120   virtual const Events_ID messageId() = 0;
 121 };
 122
 123 /// Allows to create ModelAPI messages
 124 class MODELAPI_EXPORT ModelAPI_EventCreator
 125 {
 126 public:
 127   /// creates created, updated or moved messages and sends to the loop
 128   virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent,
 129                            const bool isGroupped = true) const = 0;
 130   /// creates deleted message and sends to the loop
 131   virtual void sendDeleted(const std::shared_ptr<ModelAPI_Document>& theDoc,
 132                            const std::string& theGroup) const = 0;
 133   /// creates reordered message and sends to the loop
 134   virtual void sendReordered(const std::shared_ptr<ModelAPI_Document>& theDoc,
 135                              const std::string& theGroup) const = 0;
 136
 137   /// returns the creator instance
 138   static const ModelAPI_EventCreator* get();
 139
 140   /// sets the creator instance
 141   static void set(const ModelAPI_EventCreator* theCreator);
 142 };
 143
 144 // TODO(sbh): Move this message into a separate package, like "GuiAPI"
 145 /// Contains the state information about the feature: is it enabled or disabled.
 146 class ModelAPI_FeatureStateMessage : public Events_Message
 147 {
 148 public:
 149   /// Creates an empty message
 150   MODELAPI_EXPORT ModelAPI_FeatureStateMessage(const Events_ID theID, const void* theSender = 0);
 151   /// The virtual destructor
 152   MODELAPI_EXPORT virtual ~ModelAPI_FeatureStateMessage();
 153
 154   /// Returns the feature this message is related to
 155   MODELAPI_EXPORT std::shared_ptr<ModelAPI_Feature> feature() const;
 156   /// Stores the feature this message is related to
 157   MODELAPI_EXPORT void setFeature(std::shared_ptr<ModelAPI_Feature>& theFeature);
 158   // For response
 159   /// Returns true if feature has specific state
 160   MODELAPI_EXPORT bool hasState(const std::string& theFeatureId) const;
 161   /// Returns true if feature is enabled
 162   MODELAPI_EXPORT bool state(const  std::string& theFeatureId, bool theDefault = false) const;
 163   /// Stores the feature state
 164   MODELAPI_EXPORT void setState(const std::string& theFeatureId, bool theValue);
 165   /// Returns all feature IDs with states
 166   MODELAPI_EXPORT std::list<std::string> features() const;
 167
 168  private:
 169   /// For Request
 170   std::shared_ptr<ModelAPI_Feature> myCurrentFeature;
 171   /// For response
 172   std::map<std::string, bool> myFeatureState;
 173 };
 174
 175 /// Message that document (Part, PartSet) was created
 176 class ModelAPI_DocumentCreatedMessage : public Events_Message
 177 {
 178   DocumentPtr myDocument;
 179
 180  public:
 181   /// Creates an empty message
 182   MODELAPI_EXPORT ModelAPI_DocumentCreatedMessage(const Events_ID theID, const void* theSender = 0);
 183   /// The virtual destructor
 184   MODELAPI_EXPORT virtual ~ModelAPI_DocumentCreatedMessage();
 185   /// Static. Returns EventID of the message.
 186   MODELAPI_EXPORT static Events_ID eventId()
 187   {
 188     static const char * MY_DOCUMENT_CREATED_EVENT_ID("DocumentCreated");
 189     return Events_Loop::eventByName(MY_DOCUMENT_CREATED_EVENT_ID);
 190   }
 191
 192   /// Returns a document stored in the message
 193   MODELAPI_EXPORT DocumentPtr document() const;
 194   /// Sets a document to the message
 195   MODELAPI_EXPORT void setDocument(DocumentPtr theDocument);
 196 };
 197
 198 /// Message that attribute text should be evaluated in the attribute value
 199 class ModelAPI_AttributeEvalMessage : public Events_Message
 200 {
 201   AttributePtr myAttribute;
 202
 203  public:
 204   /// Static. Returns EventID of the message.
 205   MODELAPI_EXPORT static Events_ID& eventId()
 206   {
 207     static const char * MY_ATTRIBUTE_EVALUATION_EVENT_ID("AttributeEvaluationRequest");
 208     static Events_ID anId = Events_Loop::eventByName(MY_ATTRIBUTE_EVALUATION_EVENT_ID);
 209     return anId;
 210   }
 211
 212   /// Useful method that creates and sends the AttributeEvalMessage event
 213   MODELAPI_EXPORT static void send(AttributePtr theAttribute, const void* theSender)
 214   {
 215     std::shared_ptr<ModelAPI_AttributeEvalMessage> aMessage =
 216       std::shared_ptr<ModelAPI_AttributeEvalMessage>(
 217       new ModelAPI_AttributeEvalMessage(eventId(), theSender));
 218     aMessage->setAttribute(theAttribute);
 219     Events_Loop::loop()->send(aMessage);
 220   }
 221
 222   /// Creates an empty message
 223   MODELAPI_EXPORT ModelAPI_AttributeEvalMessage(const Events_ID theID, const void* theSender = 0);
 224   /// The virtual destructor
 225   MODELAPI_EXPORT virtual ~ModelAPI_AttributeEvalMessage();
 226
 227   /// Returns a document stored in the message
 228   MODELAPI_EXPORT AttributePtr attribute() const;
 229   /// Sets an attribute to the message
 230   MODELAPI_EXPORT void setAttribute(AttributePtr theAttribute);
 231 };
 232
 233 /// Message that the object is renamed
 234 class ModelAPI_ObjectRenamedMessage : public Events_Message
 235 {
 236   ObjectPtr myObject;
 237   std::string myOldName;
 238   std::string myNewName;
 239
 240  public:
 241   /// Static. Returns EventID of the message.
 242   MODELAPI_EXPORT static Events_ID& eventId()
 243   {
 244     static const char * MY_OBJECT_RENAMED_EVENT_ID("ObjectRenamed");
 245     static Events_ID anId = Events_Loop::eventByName(MY_OBJECT_RENAMED_EVENT_ID);
 246     return anId;
 247   }
 248
 249   /// Useful method that creates and sends the AttributeEvalMessage event
 250   MODELAPI_EXPORT static void send(ObjectPtr theObject,
 251                                    const std::string& theOldName,
 252                                    const std::string& theNewName,
 253                                    const void* theSender);
 254
 255   /// Creates an empty message
 256   MODELAPI_EXPORT ModelAPI_ObjectRenamedMessage(const Events_ID theID, const void* theSender = 0);
 257   /// The virtual destructor
 258   MODELAPI_EXPORT virtual ~ModelAPI_ObjectRenamedMessage();
 259
 260   /// Returns an object
 261   MODELAPI_EXPORT ObjectPtr object() const;
 262   /// Sets an object
 263   MODELAPI_EXPORT void setObject(ObjectPtr theObject);
 264   /// Returns an old name
 265   MODELAPI_EXPORT std::string oldName() const;
 266   /// Sets an old name
 267   MODELAPI_EXPORT void setOldName(const std::string& theOldName);
 268   /// Returns a new name
 269   MODELAPI_EXPORT std::string newName() const;
 270   /// Sets a new name
 271   MODELAPI_EXPORT void setNewName(const std::string& theNewName);
 272 };
 273
 274 #endif