1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModelAPI_Document.cxx
4 // Created: 28 Feb 2014
5 // Author: Mikhail PONIKAROV
7 #ifndef ModelAPI_Document_H_
8 #define ModelAPI_Document_H_
16 class ModelAPI_Feature;
17 class ModelAPI_Object;
18 class ModelAPI_Result;
19 class ModelAPI_ResultConstruction;
20 class ModelAPI_ResultBody;
21 class ModelAPI_ResultPart;
22 class ModelAPI_ResultGroup;
25 /**\class ModelAPI_Document
27 * \brief Document for internal data structure of any object storage.
28 * Document contains all data that must be stored/retrived in the file.
29 * Also it provides acces to this data: open/save, transactions management etc.
31 class ModelAPI_Document
34 //! Returns the kind of the document: "PartSet", "Part", or something else.
35 //! This kind is used for feature buttons enable/disable depending on active document
36 //! (it uses workbench "document" identifier in XML configuration file for this)
37 virtual const std::string& kind() const = 0;
39 //! Removes document data
40 //! \param theForever if it is false, document is just hiden (to keep possibility make it back on Undo/Redo)
41 virtual void close(const bool theForever = false) = 0;
43 //! Adds to the document the new feature of the given feature id
44 //! \param theID creates feature and puts it in the document (if it is not action)
45 virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID) = 0;
47 //! Removes the feature from the document
48 virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature,
49 const bool theCheck = true) = 0;
51 ///! Adds a new sub-document by the identifier, or returns existing one if it is already exist
52 virtual std::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID) = 0;
54 ///! Returns the id of the document
55 virtual const std::string& id() const = 0;
57 //! Returns the object in the group by the index (started from zero)
58 //! \param theGroupID group that contains an object
59 //! \param theIndex zero-based index of feature in the group
60 //! \param theHidden if it is true, it counts also the features that are not in tree
61 virtual std::shared_ptr<ModelAPI_Object> object(const std::string& theGroupID,
63 const bool theHidden = false) = 0;
65 //! Returns the number of objects in the group of objects
66 //! If theHidden is true, it counts also the features that are not in tree
67 virtual int size(const std::string& theGroupID, const bool theHidden = false) = 0;
69 /// To virtually destroy the fields of successors
70 MODELAPI_EXPORT virtual ~ModelAPI_Document();
72 /// Creates a construction cresults
73 virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
74 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
75 /// Creates a body results
76 virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
77 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
78 /// Creates a part results
79 virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
80 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
81 /// Creates a group results
82 virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
83 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
85 //! Returns a feature by result (owner of result)
86 virtual std::shared_ptr<ModelAPI_Feature> feature(
87 const std::shared_ptr<ModelAPI_Result>& theResult) = 0;
90 /// Only for SWIG wrapping it is here
91 MODELAPI_EXPORT ModelAPI_Document();
94 //! Pointer on document object
95 typedef std::shared_ptr<ModelAPI_Document> DocumentPtr;