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