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_
11 #include "ModelAPI_Entity.h"
19 class ModelAPI_Feature;
20 class ModelAPI_Object;
21 class ModelAPI_Result;
22 class ModelAPI_ResultConstruction;
23 class ModelAPI_ResultBody;
24 class ModelAPI_ResultPart;
25 class ModelAPI_ResultGroup;
26 class ModelAPI_ResultParameter;
29 /**\class ModelAPI_Document
31 * \brief Document for internal data structure of any object storage.
32 * Document contains all data that must be stored/retrived in the file.
33 * Also it provides acces to this data: open/save, transactions management etc.
35 class ModelAPI_Document: public ModelAPI_Entity
38 //! Returns the kind of the document: "PartSet", "Part", or something else.
39 //! This kind is used for feature buttons enable/disable depending on active document
40 //! (it uses workbench "document" identifier in XML configuration file for this)
41 virtual const std::string& kind() const = 0;
43 //! Removes document data
44 //! \param theForever if it is false, document is just hiden (to keep possibility make it back on Undo/Redo)
45 virtual void close(const bool theForever = false) = 0;
47 //! Adds to the document the new feature of the given feature id
48 //! \param theID creates feature and puts it in the document (if it is not action)
49 //! \param theMakeCurrent to make current this new feature in this document
50 virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID,
51 const bool theMakeCurrent = true) = 0;
53 //! Return a list of features, which refers to the feature
54 //! \param theFeature a feature
55 //! \param theRefs a list of features
56 //! \param isSendError a flag whether the error message should be send
57 virtual void refsToFeature(std::shared_ptr<ModelAPI_Feature> theFeature,
58 std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs,
59 const bool isSendError = true) = 0;
61 //! Removes the feature from the document
62 //! \param theFeature a feature to be removed
63 virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature) = 0;
65 //! Moves the feature to make it after the given one in the history.
66 virtual void moveFeature(std::shared_ptr<ModelAPI_Feature> theMoved,
67 std::shared_ptr<ModelAPI_Feature> theAfterThis) = 0;
69 ///! Adds a new sub-document by the identifier, or returns existing one if it is already exist
70 virtual std::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID) = 0;
72 ///! Returns the id of the document
73 virtual const std::string& id() const = 0;
75 //! Returns the object in the group by the index (started from zero)
76 //! \param theGroupID group that contains an object
77 //! \param theIndex zero-based index of feature in the group
78 virtual std::shared_ptr<ModelAPI_Object> object(const std::string& theGroupID,
79 const int theIndex) = 0;
81 //! Returns the first found object in the group by the object name
82 //! \param theGroupID group that contains an object
83 //! \param theName name of the object to search
84 //! \returns null if such object is not found
85 virtual std::shared_ptr<ModelAPI_Object> objectByName(const std::string& theGroupID,
86 const std::string& theName) = 0;
88 //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
89 //! \param theObject object of this document
90 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
91 virtual const int index(std::shared_ptr<ModelAPI_Object> theObject) = 0;
93 //! Returns the number of objects in the group of objects
94 virtual int size(const std::string& theGroupID) = 0;
96 //! Returns the feature that is currently edited in this document, normally
97 //! this is the latest created feature
98 //! \param theVisible use visible features only: flag is true for Object Browser functionality
99 //! \returns null if next created feature must be the first
100 virtual std::shared_ptr<ModelAPI_Feature> currentFeature(const bool theVisible) = 0;
102 //! Sets the current feature: all features below will be disabled, new features
103 //! will be appended after this one.
104 //! \param theCurrent the selected feature as current: blow it everythin become disabled
105 //! \param theVisible use visible features only: flag is true for Object Browser functionality
106 virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
107 const bool theVisible) = 0;
108 //! Makes the current feature one feature upper
109 virtual void setCurrentFeatureUp() = 0;
111 //! Returns the number of all features: in the history or not
112 virtual int numInternalFeatures() = 0;
113 //! Returns the feature by zero-based index: features in the history or not
114 virtual std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex) = 0;
115 //! Performs synchronization of transactions with the module document:
116 //! If some document is not active (by undo of activation) but in memory,
117 //! on activation the transactions must be synchronised because all redos performed
118 //! wihtout this participation
119 virtual void synchronizeTransactions() = 0;
122 //! To virtually destroy the fields of successors
123 MODELAPI_EXPORT virtual ~ModelAPI_Document();
125 //! Creates a construction result
126 virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
127 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
128 //! Creates a body result
129 virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
130 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
131 //! Creates a part result
132 virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
133 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
134 //! Copies a part result, keeping the reference to the origin
135 virtual std::shared_ptr<ModelAPI_ResultPart> copyPart(
136 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
137 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
138 //! Creates a group result
139 virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
140 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
141 //! Creates a parameter result
142 virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
143 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
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;
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;
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;
158 /// Returns true if document is opened and valid
159 virtual bool isOpened() = 0;
163 //! Only for SWIG wrapping it is here
164 MODELAPI_EXPORT ModelAPI_Document();
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;
171 friend class ModelAPI_Object; // to add or remove from the history
172 friend class ModelAPI_Result; // to add or remove from the history
175 //! Pointer on document object
176 typedef std::shared_ptr<ModelAPI_Document> DocumentPtr;