1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef Model_Objects_H_
22 #define Model_Objects_H_
25 #include <ModelAPI_Document.h>
26 #include <ModelAPI_Feature.h>
27 #include <ModelAPI_Folder.h>
28 #include <ModelAPI_Result.h>
29 #include <ModelAPI_ResultParameter.h>
31 #include <TDocStd_Document.hxx>
32 #include <NCollection_DataMap.hxx>
33 #include <TDF_Label.hxx>
34 #include <TDF_LabelList.hxx>
39 // for TDF_Label map usage
40 static Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper);
41 static Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2);
43 /**\class Model_Objects
45 * \brief Manager of objects of the document. Normally one this class corresponds to
46 * one document and just helper to manage objects (ModelAPI_Objects) inside of the document
47 * on the level of data storage.
52 //! Registers the fieature in the data structure
53 //! \param theFeature feature that must be added to the data structure
54 //! \param theAfterThis the feature will be added after this feature;
55 //! if it is null, the added feature will be the first
56 void addFeature(FeaturePtr theFeature, const FeaturePtr theAfterThis);
58 //! Return a list of features, which refers to the feature
59 //! \param theFeature a feature
60 //! \param theRefs a list of reference features
61 //! \param isSendError a flag whether the error message should be send
62 void refsToFeature(FeaturePtr theFeature,
63 std::set<FeaturePtr>& theRefs,
64 const bool isSendError = true);
66 //! Removes the feature from the document (with result)
67 //! \param theFeature a removed feature
68 void removeFeature(FeaturePtr theFeature);
70 //! Moves the feature to make it after the given one in the history.
71 void moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis);
73 //! Returns the existing feature by the label
74 //! \param theLabel base label of the feature
75 FeaturePtr feature(TDF_Label theLabel) const;
77 //! Returns the existing object: result or feature
78 //! \param theLabel base label of the object
79 ObjectPtr object(TDF_Label theLabel);
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 std::shared_ptr<ModelAPI_Object> objectByName(
86 const std::string& theGroupID, const std::string& theName);
88 //! Returns the result by the result name
89 ResultPtr findByName(const std::string theName);
92 //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
93 //! \param theObject object of this document
94 //! \param theAllowFolder take into account grouping feature by folders
95 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
96 const int index(std::shared_ptr<ModelAPI_Object> theObject,
97 const bool theAllowFolder = false);
99 //! Returns the feature in the group by the index (started from zero)
100 //! \param theGroupID group that contains a feature
101 //! \param theIndex zero-based index of feature in the group
102 //! \param theAllowFolder take into account grouping feature by folders
103 ObjectPtr object(const std::string& theGroupID,
105 const bool theAllowFolder = false);
107 //! Returns the number of features in the group
108 //! \param theGroupID group of objects
109 //! \param theAllowFolder take into account grouping feature by folders
110 int size(const std::string& theGroupID, const bool theAllowFolder = false);
112 //! Returns all (and disabled) results of the given type.
113 //! Not fast method (iterates all features).
114 void allResults(const std::string& theGroupID, std::list<ResultPtr>& theResults);
116 //! Returns the number of all features: in the history or not
117 int numInternalFeatures();
118 //! Returns the feature by zero-based index: features in the history or not
119 std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex);
121 //! Returns feature by the id of the feature (produced by the Data "featureId" method)
122 std::shared_ptr<ModelAPI_Feature> featureById(const int theId);
125 /// Creates a construction result
126 std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
127 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
128 /// Creates a body result
129 std::shared_ptr<ModelAPI_ResultBody> createBody(
130 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
131 /// Creates a part result
132 std::shared_ptr<ModelAPI_ResultPart> createPart(
133 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
134 /// Copies a part result, keeping the reference to origin
135 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);
138 /// Creates a group result
139 std::shared_ptr<ModelAPI_ResultGroup> createGroup(
140 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
141 /// Creates a field result
142 std::shared_ptr<ModelAPI_ResultField> createField(
143 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
144 /// Creates a parameter result
145 std::shared_ptr<ModelAPI_ResultParameter> createParameter(
146 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
148 //! Returns a feature by result (owner of result)
149 std::shared_ptr<ModelAPI_Feature>
150 feature(const std::shared_ptr<ModelAPI_Result>& theResult);
152 /// Creates a folder (group of the features in the object browser)
153 std::shared_ptr<ModelAPI_Folder> createFolder(
154 const std::shared_ptr<ModelAPI_Feature>& theBeforeThis);
155 //! Removes the folder from the document (all features in the folder will be kept).
156 void removeFolder(std::shared_ptr<ModelAPI_Folder> theFolder);
157 //! Search a folder applicable for the list of features
158 //! (it means the list of features stored in the folder should be consequential)
159 //! \param theFeatures list of features to be added to folder
160 //! \param theBelow search the folder below the features (if \c false, search above)
161 //! \return Empty pointer if there is no applicable folder
162 std::shared_ptr<ModelAPI_Folder> findFolder(
163 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
164 const bool theBelow);
165 //! Add a list of features to the folder. The correctness of the adding is not performed
166 //! (such checks have been done in corresponding find.. method).
167 //! \return \c true if the movement is successfull
168 bool moveToFolder(const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
169 const std::shared_ptr<ModelAPI_Folder>& theFolder);
170 //! Remove features from the folder
171 //! \param theFeatures list of features to be removed
172 //! \param theBefore extract features before the folder (this parameter is applicable only
173 //! when all features in the folder are taking out,
174 //! in other cases the direction is taken automatically)
175 //! \return \c true if the features have been moved out
176 bool removeFromFolder(const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
177 const bool theBefore = true);
179 //! Sets the owner of this manager
180 void setOwner(DocumentPtr theDoc);
182 //! Returns the owner of this manager
183 DocumentPtr owner() {return myDoc;}
185 //! Deletes all managed features wit hemmitting of corresponded signal
190 //! Returns (creates if needed) the features label
191 TDF_Label featuresLabel() const;
193 //! Initializes feature with a unique name in this group (unique name is generated as
194 //! feature type + "_" + index
195 void setUniqueName(FeaturePtr theFeature);
197 //! Initializes the foldet with an unique name ("Folder_" + index)
198 void setUniqueName(FolderPtr theFolder);
200 //! Synchronizes myFeatures list with the updated document
201 //! \param theUpdated list of labels that are marked as modified, so featrues must be also
202 //! \param theUpdateReferences causes the update of back-references
203 //! \param theExecuteFeatures requires re-execute modified persistent features
204 //! (not needed on undo/redo/abort/open)
205 //! \param theOpen - on open nothing must be reexecuted, except not persistent results
206 //! \param theFlush makes flush all events in the end of all modifications of this method
207 void synchronizeFeatures(const TDF_LabelList& theUpdated, const bool theUpdateReferences,
208 const bool theOpen, const bool theExecuteFeatures, const bool theFlush);
209 //! Synchronizes the BackReferences list in Data of Features and Results
210 void synchronizeBackRefs();
212 //! Creates manager on the OCAF document main label
213 Model_Objects(TDF_Label theMainLab);
215 //! Initializes the data fields of the feature
216 void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag);
218 //! Allows to store the result in the data tree of the document
219 //! (attaches 'data' of result to tree)
220 void storeResult(std::shared_ptr<ModelAPI_Data> theFeatureData,
221 std::shared_ptr<ModelAPI_Result> theResult,
222 const int theResultIndex = 0);
224 //! returns the label of result by index; creates this label if it was not created before
225 TDF_Label resultLabel(const std::shared_ptr<ModelAPI_Data>& theFeatureData,
226 const int theResultIndex);
228 //! Updates the results list of the feature basing on the current data tree
229 //! theProcessed is used to avoid update twice (since the function is recursive)
230 void updateResults(FeaturePtr theFeature, std::set<FeaturePtr>& theProcessed);
232 /// Internally makes document know that feature was removed or added in history after creation
233 void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject);
235 /// Internally makes document know that feature was removed or added in history after creation
236 void updateHistory(const std::string theGroup);
238 /// Clears the history arrays related to this object
239 void clearHistory(ObjectPtr theObj);
241 /// Creates the history: up to date with the current state
242 void createHistory(const std::string& theGroupID);
244 /// Returns the next (from the history point of view) feature, any: invisible or disabled
245 /// \param theCurrent previous to the resulting feature
246 /// \param theReverse if it is true, iterates in reverced order (next becomes previous)
247 FeaturePtr nextFeature(FeaturePtr theCurrent, const bool theReverse = false);
248 /// Returns to the first (from the history point of view) feature, any: invisible or disabled
249 FeaturePtr firstFeature();
250 /// Returns to the last (from the history point of view) feature, any: invisible or disabled
251 FeaturePtr lastFeature();
252 /// Returns true if theLater is in history of features creation later than theCurrent
253 bool isLater(FeaturePtr theLater, FeaturePtr theCurrent) const;
255 /// Returns the next or previous label
256 /// \param theCurrent given label
257 /// \param theReverse if it is true, iterates in reverced order (next becomes previous)
258 TDF_Label nextLabel(TDF_Label theCurrent, const bool theReverse = false);
260 /// Returns the result group identifier of the given feature (for this at least one result must
261 /// be created before)
262 std::string featureResultGroup(FeaturePtr theFeature);
264 //! Returns all features of the document including the hidden features which are not in
265 //! history. Not very fast method, for calling once, not in big cycles.
266 std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures();
268 //! Returns all objects of the document including the hidden features which are not in
269 //! history. Not very fast method, for calling once, not in big cycles.
270 std::list<std::shared_ptr<ModelAPI_Object> > allObjects();
272 //! synchronises back references for the given object basing on the collected data
273 void synchronizeBackRefsForObject(
274 const std::set<std::shared_ptr<ModelAPI_Attribute>>& theNewRefs, ObjectPtr theObject);
276 /// Just removes all features without touching the document data (to be able undo)
277 virtual void eraseAllFeatures();
279 // Check whether the pre-image of the result had user-defined name.
280 // If yes, return this name.
281 bool hasCustomName(DataPtr theFeatureData,
284 std::string& theParentName) const;
286 /// Return object representing a folder or empty pointer
287 ObjectPtr folder(TDF_Label theLabel) const;
290 TDF_Label myMain; ///< main label of the data storage
292 DocumentPtr myDoc; ///< doc,ument, owner of this objects manager: needed for events creation
294 /// All managed features (not only in history of OB)
295 /// For optimization mapped by labels
296 NCollection_DataMap<TDF_Label, FeaturePtr> myFeatures;
299 NCollection_DataMap<TDF_Label, ObjectPtr> myFolders;
301 /// Map from group id to the array that contains all objects located in history.
302 /// Each array is updated by demand from scratch, by browing all the features in the history.
303 std::map<std::string, std::vector<ObjectPtr> > myHistory;
305 friend class Model_Document;
306 friend class Model_Session;
307 friend class Model_Update;
308 friend class Model_AttributeReference;
309 friend class Model_AttributeRefAttr;
310 friend class Model_AttributeRefList;
311 friend class Model_AttributeSelection;
312 friend class Model_SelectionNaming;