src/ModelAPI/ModelAPI_Document.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModelAPI_Document.cxx
   4 // Created:     28 Feb 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef ModelAPI_Document_H_
   8 #define ModelAPI_Document_H_
   9
  10 #include "ModelAPI.h"
  11 #include "ModelAPI_Entity.h"
  12
  13 #include <string>
  14 #include <memory>
  15 #include <vector>
  16 #include <list>
  17 #include <set>
  18
  19 class ModelAPI_Feature;
  20 class ModelAPI_Object;
  21 class ModelAPI_Result;
  22 class ModelAPI_ResultConstruction;
  23 class ModelAPI_ResultBody;
  24 class ModelAPI_ResultPart;
  25 class ModelAPI_ResultGroup;
  26 class ModelAPI_ResultParameter;
  27 class ModelAPI_Data;
  28 class GeomAPI_Shape;
  29
  30 /**\class ModelAPI_Document
  31  * \ingroup DataModel
  32  * \brief Document for internal data structure of any object storage.
  33  * Document contains all data that must be stored/retrived in the file.
  34  * Also it provides acces to this data: open/save, transactions management etc.
  35  */
  36 class ModelAPI_Document: public ModelAPI_Entity
  37 {
  38 public:
  39   //! Returns the kind of the document: "PartSet", "Part", or something else.
  40   //! This kind is used for feature buttons enable/disable depending on active document
  41   //! (it uses workbench "document" identifier in XML configuration file for this)
  42   virtual const std::string& kind() const = 0;
  43
  44   //! Removes document data
  45   //! \param theForever if it is false, document is just hiden (to keep possibility make it back on Undo/Redo)
  46   virtual void close(const bool theForever = false) = 0;
  47
  48   //! Adds to the document the new feature of the given feature id
  49   //! \param theID creates feature and puts it in the document (if it is not action)
  50   //! \param theMakeCurrent to make current this new feature in this document
  51   virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID,
  52     const bool theMakeCurrent = true) = 0;
  53
  54   //! Return a list of features, which refers to the feature
  55   //! \param theFeature a feature
  56   //! \param theRefs a list of features
  57   //! \param isSendError a flag whether the error message should be send
  58   virtual void refsToFeature(std::shared_ptr<ModelAPI_Feature> theFeature,
  59                              std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs,
  60                              const bool isSendError = true) = 0;
  61
  62   //! Removes the feature from the document
  63   //! \param theFeature a feature to be removed
  64   virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature) = 0;
  65
  66   //! Moves the feature to make it after the given one in the history.
  67   virtual void moveFeature(std::shared_ptr<ModelAPI_Feature> theMoved,
  68                            std::shared_ptr<ModelAPI_Feature> theAfterThis) = 0;
  69
  70   ///! Returns the id of the document
  71   virtual const int id() const = 0;
  72
  73   //! Returns the object in the group by the index (started from zero)
  74   //! \param theGroupID group that contains an object
  75   //! \param theIndex zero-based index of feature in the group
  76   virtual std::shared_ptr<ModelAPI_Object> object(const std::string& theGroupID,
  77                                                     const int theIndex) = 0;
  78
  79   //! Returns the first found object in the group by the object name
  80   //! \param theGroupID group that contains an object
  81   //! \param theName name of the object to search
  82   //! \returns null if such object is not found
  83   virtual std::shared_ptr<ModelAPI_Object> objectByName(const std::string& theGroupID,
  84                                                     const std::string& theName) = 0;
  85
  86   //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
  87   //! \param theObject object of this document
  88   //! \returns index started from zero, or -1 if object is invisible or belongs to another document
  89   virtual const int index(std::shared_ptr<ModelAPI_Object> theObject) = 0;
  90
  91   //! Returns the number of objects in the group of objects
  92   virtual int size(const std::string& theGroupID) = 0;
  93
  94   //! Returns the feature that is currently edited in this document, normally
  95   //! this is the latest created feature
  96   //! \param theVisible use visible features only: flag is true for Object Browser functionality
  97   //! \returns null if next created feature must be the first
  98   virtual std::shared_ptr<ModelAPI_Feature> currentFeature(const bool theVisible) = 0;
  99
 100   //! Sets the current feature: all features below will be disabled, new features
 101   //! will be appended after this one. This method does not flushes the events appeared:
 102   //! it will be done by the finishOperation, or direct flushes
 103   //! \param theCurrent the selected feature as current: blow it everythin become disabled
 104   //! \param theVisible use visible features only: flag is true for Object Browser functionality
 105   virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
 106     const bool theVisible) = 0;
 107   //! Makes the current feature one feature upper
 108   virtual void setCurrentFeatureUp() = 0;
 109
 110   //! Returns the number of all features: in the history or not
 111   virtual int numInternalFeatures() = 0;
 112   //! Returns the feature by zero-based index: features in the history or not
 113   virtual std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex) = 0;
 114   //! Performs synchronization of transactions with the module document:
 115   //! If some document is not active (by undo of activation) but in memory,
 116   //! on activation the transactions must be synchronised because all redos performed
 117   //! wihtout this participation
 118   virtual void synchronizeTransactions() = 0;
 119
 120   //! Returns feature by the id of the feature (produced by the Data "featureId" method)
 121   virtual std::shared_ptr<ModelAPI_Feature> featureById(const int theId) = 0;
 122
 123   //! To virtually destroy the fields of successors
 124   MODELAPI_EXPORT virtual ~ModelAPI_Document();
 125
 126   //! Creates a construction result
 127   virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
 128       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 129   //! Creates a body result
 130   virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
 131       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 132   //! Creates a part result
 133   virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
 134       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 135   //! Copies a part result, keeping the reference to the origin
 136   virtual std::shared_ptr<ModelAPI_ResultPart> copyPart(
 137       const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
 138       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 139   //! Creates a group result
 140   virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
 141       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 142   //! Creates a parameter result
 143   virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
 144       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 145
 146   //! Returns a feature by result (owner of result)
 147   virtual std::shared_ptr<ModelAPI_Feature> feature(
 148       const std::shared_ptr<ModelAPI_Result>& theResult) = 0;
 149
 150   //! Returns all features of the document including the hidden features which are not in
 151   //! history. Not very fast method, for calling once, not in big cycles.
 152   virtual std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures() = 0;
 153
 154   //! Informs the document that it becomes active and some actions must be performed
 155   virtual void setActive(const bool theFlag) = 0;
 156   //! Returns true if this document is currently active
 157   virtual bool isActive() const = 0;
 158
 159   /// Returns true if document is opened and valid
 160   virtual bool isOpened() = 0;
 161
 162   /// Returns the feature that produced the given face of the given result.
 163   virtual std::shared_ptr<ModelAPI_Feature> producedByFeature(
 164     std::shared_ptr<ModelAPI_Result> theResult,
 165     const std::shared_ptr<GeomAPI_Shape>& theShape) = 0;
 166
 167   /// Returns true if theLater is in history of features creation later than theCurrent
 168   virtual bool isLater(std::shared_ptr<ModelAPI_Feature> theLater,
 169                        std::shared_ptr<ModelAPI_Feature> theCurrent) const = 0;
 170
 171 protected:
 172   //! Only for SWIG wrapping it is here
 173   MODELAPI_EXPORT ModelAPI_Document();
 174
 175   //! Internally makes document know that feature was removed or added in history after creation
 176   MODELAPI_EXPORT virtual void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject) = 0;
 177   //! Internally makes document know that feature was removed or added in history after creation
 178   MODELAPI_EXPORT virtual void updateHistory(const std::string theGroup) = 0;
 179
 180   friend class ModelAPI_Object; // to add or remove from the history
 181   friend class ModelAPI_Result; // to add or remove from the history
 182 };
 183
 184 //! Pointer on document object
 185 typedef std::shared_ptr<ModelAPI_Document> DocumentPtr;
 186
 187 #endif