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   virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID) = 0;
  48
  49   //! Return a list of features, which refers to the feature
  50   //! \param theFeature a feature
  51   //! \param theRefs a list of features
  52   //! \param isSendError a flag whether the error message should be send
  53   virtual void refsToFeature(std::shared_ptr<ModelAPI_Feature> theFeature,
  54                              std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs,
  55                              const bool isSendError = true) = 0;
  56
  57   //! Removes the feature from the document
  58   //! \param theFeature a feature to be removed
  59   virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature) = 0;
  60
  61   ///! Adds a new sub-document by the identifier, or returns existing one if it is already exist
  62   virtual std::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID) = 0;
  63
  64   ///! Returns the id of the document
  65   virtual const std::string& id() const = 0;
  66
  67   //! Returns the object in the group by the index (started from zero)
  68   //! \param theGroupID group that contains an object
  69   //! \param theIndex zero-based index of feature in the group
  70   //! \param theHidden if it is true, it counts also the features that are not in tree
  71   virtual std::shared_ptr<ModelAPI_Object> object(const std::string& theGroupID,
  72                                                     const int theIndex,
  73                                                     const bool theHidden = false) = 0;
  74
  75   //! Returns the first found object in the group by the object name
  76   //! \param theGroupID group that contains an object
  77   //! \param theName name of the object to search
  78   //! \returns null if such object is not found
  79   virtual std::shared_ptr<ModelAPI_Object> objectByName(const std::string& theGroupID,
  80                                                     const std::string& theName) = 0;
  81
  82   //! Returns the number of objects in the group of objects
  83   //! If theHidden is true, it counts also the features that are not in tree
  84   virtual int size(const std::string& theGroupID, const bool theHidden = false) = 0;
  85
  86   /// To virtually destroy the fields of successors
  87   MODELAPI_EXPORT virtual ~ModelAPI_Document();
  88
  89   /// Creates a construction cresults
  90   virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
  91       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
  92   /// Creates a body results
  93   virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
  94       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
  95   /// Creates a part results
  96   virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
  97       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
  98   /// Creates a group results
  99   virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
 100       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 101
 102   virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
 103       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 104
 105   //! Returns a feature by result (owner of result)
 106   virtual std::shared_ptr<ModelAPI_Feature> feature(
 107       const std::shared_ptr<ModelAPI_Result>& theResult) = 0;
 108
 109 protected:
 110   /// Only for SWIG wrapping it is here
 111   MODELAPI_EXPORT ModelAPI_Document();
 112
 113   /// Internally makes document know that feature was removed or added in history after creation
 114   MODELAPI_EXPORT virtual void addToHistory(const std::shared_ptr<ModelAPI_Object> theObject) = 0;
 115
 116   friend class ModelAPI_Object; // to add or remove from the history
 117 };
 118
 119 //! Pointer on document object
 120 typedef std::shared_ptr<ModelAPI_Document> DocumentPtr;
 121
 122 #endif