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_ResultCompSolid;
  25 class ModelAPI_ResultPart;
  26 class ModelAPI_ResultGroup;
  27 class ModelAPI_ResultParameter;
  28 class ModelAPI_Data;
  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   ///! Adds a new sub-document by the identifier, or returns existing one if it is already exist
  71   virtual std::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID) = 0;
  72
  73   ///! Returns the id of the document
  74   virtual const std::string& id() const = 0;
  75
  76   //! Returns the object in the group by the index (started from zero)
  77   //! \param theGroupID group that contains an object
  78   //! \param theIndex zero-based index of feature in the group
  79   virtual std::shared_ptr<ModelAPI_Object> object(const std::string& theGroupID,
  80                                                     const int theIndex) = 0;
  81
  82   //! Returns the first found object in the group by the object name
  83   //! \param theGroupID group that contains an object
  84   //! \param theName name of the object to search
  85   //! \returns null if such object is not found
  86   virtual std::shared_ptr<ModelAPI_Object> objectByName(const std::string& theGroupID,
  87                                                     const std::string& theName) = 0;
  88
  89   //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
  90   //! \param theObject object of this document
  91   //! \returns index started from zero, or -1 if object is invisible or belongs to another document
  92   virtual const int index(std::shared_ptr<ModelAPI_Object> theObject) = 0;
  93
  94   //! Returns the number of objects in the group of objects
  95   virtual int size(const std::string& theGroupID) = 0;
  96
  97   //! Returns the feature that is currently edited in this document, normally
  98   //! this is the latest created feature
  99   //! \param theVisible use visible features only: flag is true for Object Browser functionality
 100   //! \returns null if next created feature must be the first
 101   virtual std::shared_ptr<ModelAPI_Feature> currentFeature(const bool theVisible) = 0;
 102
 103   //! Sets the current feature: all features below will be disabled, new features
 104   //! will be appended after this one.
 105   //! \param theCurrent the selected feature as current: blow it everythin become disabled
 106   //! \param theVisible use visible features only: flag is true for Object Browser functionality
 107   virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
 108     const bool theVisible) = 0;
 109   //! Makes the current feature one feature upper
 110   virtual void setCurrentFeatureUp() = 0;
 111
 112   //! Returns the number of all features: in the history or not
 113   virtual int numInternalFeatures() = 0;
 114   //! Returns the feature by zero-based index: features in the history or not
 115   virtual std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex) = 0;
 116
 117
 118   //! To virtually destroy the fields of successors
 119   MODELAPI_EXPORT virtual ~ModelAPI_Document();
 120
 121   //! Creates a construction cresults
 122   virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
 123       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 124   //! Creates a body results
 125   virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
 126       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 127   /// Creates a compsolid results
 128   virtual std::shared_ptr<ModelAPI_ResultCompSolid> createCompSolid(
 129       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 130   //! Creates a part results
 131   virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
 132       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 133   //! Copies a part result, keeping the same data
 134   virtual std::shared_ptr<ModelAPI_ResultPart> copyPart(
 135       const std::shared_ptr<ModelAPI_Result>& theOldPart,
 136       const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
 137       const int theIndex = 0) = 0;
 138   //! Creates a group results
 139   virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
 140       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 141
 142   virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
 143       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 144
 145   //! Returns a feature by result (owner of result)
 146   virtual std::shared_ptr<ModelAPI_Feature> feature(
 147       const std::shared_ptr<ModelAPI_Result>& theResult) = 0;
 148
 149   //! Returns all features of the document including the hidden features which are not in
 150   //! history. Not very fast method, for calling once, not in big cycles.
 151   virtual std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures() = 0;
 152
 153   //! Informs the document that it becomes active and some actions must be performed
 154   virtual void setActive(const bool theFlag) = 0;
 155   //! Returns true if this document is currently active
 156   virtual bool isActive() const = 0;
 157
 158   /// Returns true if document is opened and valid
 159   virtual bool isOpened() = 0;
 160
 161
 162 protected:
 163   //! Only for SWIG wrapping it is here
 164   MODELAPI_EXPORT ModelAPI_Document();
 165
 166   //! Internally makes document know that feature was removed or added in history after creation
 167   MODELAPI_EXPORT virtual void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject) = 0;
 168   //! Internally makes document know that feature was removed or added in history after creation
 169   MODELAPI_EXPORT virtual void updateHistory(const std::string theGroup) = 0;
 170
 171   friend class ModelAPI_Object; // to add or remove from the history
 172   friend class ModelAPI_Result; // to add or remove from the history
 173 };
 174
 175 //! Pointer on document object
 176 typedef std::shared_ptr<ModelAPI_Document> DocumentPtr;
 177
 178 #endif