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 <string>
  12 #include <memory>
  13 #include <vector>
  14 #include <list>
  15 #include <set>
  16
  17 class ModelAPI_Feature;
  18 class ModelAPI_Object;
  19 class ModelAPI_Result;
  20 class ModelAPI_ResultConstruction;
  21 class ModelAPI_ResultBody;
  22 class ModelAPI_ResultPart;
  23 class ModelAPI_ResultGroup;
  24 class ModelAPI_ResultParameter;
  25 class ModelAPI_Data;
  26
  27 /**\class ModelAPI_Document
  28  * \ingroup DataModel
  29  * \brief Document for internal data structure of any object storage.
  30  * Document contains all data that must be stored/retrived in the file.
  31  * Also it provides acces to this data: open/save, transactions management etc.
  32  */
  33 class ModelAPI_Document
  34 {
  35 public:
  36   //! Returns the kind of the document: "PartSet", "Part", or something else.
  37   //! This kind is used for feature buttons enable/disable depending on active document
  38   //! (it uses workbench "document" identifier in XML configuration file for this)
  39   virtual const std::string& kind() const = 0;
  40
  41   //! Removes document data
  42   //! \param theForever if it is false, document is just hiden (to keep possibility make it back on Undo/Redo)
  43   virtual void close(const bool theForever = false) = 0;
  44
  45   //! Adds to the document the new feature of the given feature id
  46   //! \param theID creates feature and puts it in the document (if it is not action)
  47   //! \param theMakeCurrent to make current this new feature in this document
  48   virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID,
  49     const bool theMakeCurrent = true) = 0;
  50
  51   //! Return a list of features, which refers to the feature
  52   //! \param theFeature a feature
  53   //! \param theRefs a list of features
  54   //! \param isSendError a flag whether the error message should be send
  55   virtual void refsToFeature(std::shared_ptr<ModelAPI_Feature> theFeature,
  56                              std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs,
  57                              const bool isSendError = true) = 0;
  58
  59   //! Removes the feature from the document
  60   //! \param theFeature a feature to be removed
  61   virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature) = 0;
  62
  63   //! Moves the feature to make it after the given one in the history.
  64   virtual void moveFeature(std::shared_ptr<ModelAPI_Feature> theMoved,
  65                            std::shared_ptr<ModelAPI_Feature> theAfterThis) = 0;
  66
  67   ///! Adds a new sub-document by the identifier, or returns existing one if it is already exist
  68   virtual std::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID) = 0;
  69
  70   ///! Returns the id of the document
  71   virtual const std::string& 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.
 102   //! \param theCurrent the selected feature as current: blow it everythin become disabled
 103   //! \param theVisible use visible features only: flag is true for Object Browser functionality
 104   virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
 105     const bool theVisible) = 0;
 106   //! Makes the current feature one feature upper
 107   virtual void setCurrentFeatureUp() = 0;
 108
 109   //! Returns the number of all features: in the history or not
 110   virtual int numInternalFeatures() = 0;
 111   //! Returns the feature by zero-based index: features in the history or not
 112   virtual std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex) = 0;
 113
 114
 115   //! To virtually destroy the fields of successors
 116   MODELAPI_EXPORT virtual ~ModelAPI_Document();
 117
 118   //! Creates a construction cresults
 119   virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
 120       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 121   //! Creates a body results
 122   virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
 123       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 124   //! Creates a part results
 125   virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
 126       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 127   //! Copies a part result, keeping the same data
 128   virtual std::shared_ptr<ModelAPI_ResultPart> copyPart(
 129       const std::shared_ptr<ModelAPI_Result>& theOldPart,
 130       const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
 131       const int theIndex = 0) = 0;
 132   //! Creates a group results
 133   virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
 134       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 135
 136   virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
 137       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 138
 139   //! Returns a feature by result (owner of result)
 140   virtual std::shared_ptr<ModelAPI_Feature> feature(
 141       const std::shared_ptr<ModelAPI_Result>& theResult) = 0;
 142
 143   //! Returns all features of the document including the hidden features which are not in
 144   //! history. Not very fast method, for calling once, not in big cycles.
 145   virtual std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures() = 0;
 146
 147   //! Informs the document that it becomes active and some actions must be performed
 148   virtual void setActive(const bool theFlag) = 0;
 149   //! Returns true if this document is currently active
 150   virtual bool isActive() const = 0;
 151
 152   /// Returns true if document is opened and valid
 153   virtual bool isOpened() = 0;
 154
 155
 156 protected:
 157   //! Only for SWIG wrapping it is here
 158   MODELAPI_EXPORT ModelAPI_Document();
 159
 160   //! Internally makes document know that feature was removed or added in history after creation
 161   MODELAPI_EXPORT virtual void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject) = 0;
 162   //! Internally makes document know that feature was removed or added in history after creation
 163   MODELAPI_EXPORT virtual void updateHistory(const std::string theGroup) = 0;
 164
 165   friend class ModelAPI_Object; // to add or remove from the history
 166   friend class ModelAPI_Result; // to add or remove from the history
 167 };
 168
 169 //! Pointer on document object
 170 typedef std::shared_ptr<ModelAPI_Document> DocumentPtr;
 171
 172 #endif