src/ModelAPI/ModelAPI_Document.h

   1 // File:        ModelAPI_Document.cxx
   2 // Created:     28 Feb 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #ifndef ModelAPI_Document_H_
   6 #define ModelAPI_Document_H_
   7
   8 #include <ModelAPI.h>
   9 #include <string>
  10 #include <boost/shared_ptr.hpp>
  11 #include <vector>
  12 #include <list>
  13
  14 class ModelAPI_Feature;
  15 class ModelAPI_Object;
  16 class ModelAPI_Result;
  17 class ModelAPI_ResultConstruction;
  18 class ModelAPI_ResultBody;
  19 class ModelAPI_ResultPart;
  20 class ModelAPI_Data;
  21
  22 /**\class Model_Document
  23  * \ingroup DataModel
  24  * \brief Document for internal data structure of any object storage.
  25  * Document contains all data that must be stored/retrived in the file.
  26  * Also it provides acces to this data: open/save, transactions management etc.
  27  */
  28 class ModelAPI_Document
  29 {
  30 public:
  31   //! Returns the kind of the document: "PartSet", "Part", or something else.
  32   //! This kind is used for feature buttons enable/disable depending on active document
  33   //! (it uses workbench "document" identifier in XML configuration file for this)
  34   virtual const std::string& kind() const = 0;
  35
  36   //! Removes document data
  37   virtual void close() = 0;
  38
  39   //! Adds to the document the new feature of the given feature id
  40   //! \param creates feature and puts it in the document (if it is not action)
  41   virtual boost::shared_ptr<ModelAPI_Feature> addFeature(std::string theID) = 0;
  42
  43   //! Removes the feature from the document
  44   virtual void removeFeature(boost::shared_ptr<ModelAPI_Feature> theFeature) = 0;
  45
  46   ///! Adds a new sub-document by the identifier, or returns existing one if it is already exist
  47   virtual boost::shared_ptr<ModelAPI_Document>
  48     subDocument(std::string theDocID) = 0;
  49
  50   ///! Returns the id of the document
  51   virtual const std::string& id() const = 0;
  52
  53   //! Returns the object in the group by the index (started from zero)
  54   //! \param theGroupID group that contains an object
  55   //! \param theIndex zero-based index of feature in the group
  56   //! \param theHidden if it is true, it counts also the features that are not in tree
  57   virtual boost::shared_ptr<ModelAPI_Object>
  58   object(const std::string& theGroupID, const int theIndex, const bool theHidden = false) = 0;
  59
  60   //! Returns the number of objects in the group of objects
  61   //! If theHidden is true, it counts also the features that are not in tree
  62   virtual int size(const std::string& theGroupID, const bool theHidden = false) = 0;
  63
  64   /// To virtually destroy the fields of successors
  65   virtual ~ModelAPI_Document()
  66   {
  67   }
  68
  69   /// Creates a construction cresults
  70   virtual boost::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
  71       const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
  72   /// Creates a body results
  73   virtual boost::shared_ptr<ModelAPI_ResultBody> createBody(
  74       const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
  75   /// Creates a part results
  76   virtual boost::shared_ptr<ModelAPI_ResultPart> createPart(
  77       const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
  78
  79   //! Returns a feature by result (owner of result)
  80   virtual boost::shared_ptr<ModelAPI_Feature> feature(
  81       const boost::shared_ptr<ModelAPI_Result>& theResult) = 0;
  82
  83  protected:
  84   /// Only for SWIG wrapping it is here
  85   MODELAPI_EXPORT ModelAPI_Document()
  86   {
  87   }
  88 };
  89
  90 //! Pointer on document object
  91 typedef boost::shared_ptr<ModelAPI_Document> DocumentPtr;
  92
  93 #endif