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 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
95 const int index(std::shared_ptr<ModelAPI_Object> theObject);
97 //! Returns the feature in the group by the index (started from zero)
98 //! \param theGroupID group that contains a feature
99 //! \param theIndex zero-based index of feature in the group
100 //! \param theAllowFolder take into account grouping feature by folders
101 ObjectPtr object(const std::string& theGroupID,
103 const bool theAllowFolder = false);
105 //! Returns the number of features in the group
106 //! \param theGroupID group of objects
107 //! \param theAllowFolder take into account grouping feature by folders
108 int size(const std::string& theGroupID, const bool theAllowFolder = false);
110 //! Returns all (and disabled) results of the given type.
111 //! Not fast method (iterates all features).
112 void allResults(const std::string& theGroupID, std::list<ResultPtr>& theResults);
114 //! Returns the number of all features: in the history or not
115 int numInternalFeatures();
116 //! Returns the feature by zero-based index: features in the history or not
117 std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex);
119 //! Returns feature by the id of the feature (produced by the Data "featureId" method)
120 std::shared_ptr<ModelAPI_Feature> featureById(const int theId);
123 /// Creates a construction result
124 std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
125 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
126 /// Creates a body result
127 std::shared_ptr<ModelAPI_ResultBody> createBody(
128 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
129 /// Creates a part result
130 std::shared_ptr<ModelAPI_ResultPart> createPart(
131 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
132 /// Copies a part result, keeping the reference to origin
133 std::shared_ptr<ModelAPI_ResultPart> copyPart(
134 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
135 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
136 /// Creates a group result
137 std::shared_ptr<ModelAPI_ResultGroup> createGroup(
138 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
139 /// Creates a field result
140 std::shared_ptr<ModelAPI_ResultField> createField(
141 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
142 /// Creates a parameter result
143 std::shared_ptr<ModelAPI_ResultParameter> createParameter(
144 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
146 //! Returns a feature by result (owner of result)
147 std::shared_ptr<ModelAPI_Feature>
148 feature(const std::shared_ptr<ModelAPI_Result>& theResult);
150 /// Creates a folder (group of the features in the object browser)
151 std::shared_ptr<ModelAPI_Folder> createFolder(
152 const std::shared_ptr<ModelAPI_Feature>& theBeforeThis);
153 //! Removes the folder from the document (all features in the folder will be kept).
154 void removeFolder(std::shared_ptr<ModelAPI_Folder> theFolder);
155 //! Search a folder applicable for the list of features
156 //! (it means the list of features stored in the folder should be consequential)
157 //! \param theFeatures list of features to be added to folder
158 //! \param theBelow search the folder below the features (if \c false, search above)
159 //! \return Empty pointer if there is no applicable folder
160 std::shared_ptr<ModelAPI_Folder> findFolder(
161 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
162 const bool theBelow);
163 //! Add a list of features to the folder. The correctness of the adding is not performed
164 //! (such checks have been done in corresponding find.. method).
165 //! \return \c true if the movement is successfull
166 bool moveToFolder(const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
167 const std::shared_ptr<ModelAPI_Folder>& theFolder);
168 //! Remove features from the folder
169 //! \return \c true if the features have been moved out
170 bool removeFromFolder(const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures);
172 //! Sets the owner of this manager
173 void setOwner(DocumentPtr theDoc);
175 //! Returns the owner of this manager
176 DocumentPtr owner() {return myDoc;}
178 //! Deletes all managed features wit hemmitting of corresponded signal
183 //! Returns (creates if needed) the features label
184 TDF_Label featuresLabel() const;
186 //! Initializes feature with a unique name in this group (unique name is generated as
187 //! feature type + "_" + index
188 void setUniqueName(FeaturePtr theFeature);
190 //! Initializes the foldet with an unique name ("Folder_" + index)
191 void setUniqueName(FolderPtr theFolder);
193 //! Synchronizes myFeatures list with the updated document
194 //! \param theUpdated list of labels that are marked as modified, so featrues must be also
195 //! \param theUpdateReferences causes the update of back-references
196 //! \param theExecuteFeatures requires re-execute modified persistent features
197 //! (not needed on undo/redo/abort/open)
198 //! \param theOpen - on open nothing must be reexecuted, except not persistent results
199 //! \param theFlush makes flush all events in the end of all modifications of this method
200 void synchronizeFeatures(const TDF_LabelList& theUpdated, const bool theUpdateReferences,
201 const bool theOpen, const bool theExecuteFeatures, const bool theFlush);
202 //! Synchronizes the BackReferences list in Data of Features and Results
203 void synchronizeBackRefs();
205 //! Creates manager on the OCAF document main label
206 Model_Objects(TDF_Label theMainLab);
208 //! Initializes the data fields of the feature
209 void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag);
211 //! Allows to store the result in the data tree of the document
212 //! (attaches 'data' of result to tree)
213 void storeResult(std::shared_ptr<ModelAPI_Data> theFeatureData,
214 std::shared_ptr<ModelAPI_Result> theResult,
215 const int theResultIndex = 0);
217 //! returns the label of result by index; creates this label if it was not created before
218 TDF_Label resultLabel(const std::shared_ptr<ModelAPI_Data>& theFeatureData,
219 const int theResultIndex);
221 //! Updates the results list of the feature basing on the current data tree
222 //! theProcessed is used to avoid update twice (since the function is recursive)
223 void updateResults(FeaturePtr theFeature, std::set<FeaturePtr>& theProcessed);
225 /// Internally makes document know that feature was removed or added in history after creation
226 void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject);
228 /// Internally makes document know that feature was removed or added in history after creation
229 void updateHistory(const std::string theGroup);
231 /// Clears the history arrays related to this object
232 void clearHistory(ObjectPtr theObj);
234 /// Creates the history: up to date with the current state
235 void createHistory(const std::string& theGroupID);
237 /// Returns the next (from the history point of view) feature, any: invisible or disabled
238 /// \param theCurrent previous to the resulting feature
239 /// \param theReverse if it is true, iterates in reverced order (next becomes previous)
240 FeaturePtr nextFeature(FeaturePtr theCurrent, const bool theReverse = false);
241 /// Returns to the first (from the history point of view) feature, any: invisible or disabled
242 FeaturePtr firstFeature();
243 /// Returns to the last (from the history point of view) feature, any: invisible or disabled
244 FeaturePtr lastFeature();
245 /// Returns true if theLater is in history of features creation later than theCurrent
246 bool isLater(FeaturePtr theLater, FeaturePtr theCurrent) const;
248 /// Returns the next or previous label
249 /// \param theCurrent given label
250 /// \param theReverse if it is true, iterates in reverced order (next becomes previous)
251 TDF_Label nextLabel(TDF_Label theCurrent, const bool theReverse = false);
253 /// Returns the result group identifier of the given feature (for this at least one result must
254 /// be created before)
255 std::string featureResultGroup(FeaturePtr theFeature);
257 //! Returns all features of the document including the hidden features which are not in
258 //! history. Not very fast method, for calling once, not in big cycles.
259 std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures();
261 //! Returns all objects of the document including the hidden features which are not in
262 //! history. Not very fast method, for calling once, not in big cycles.
263 std::list<std::shared_ptr<ModelAPI_Object> > allObjects();
265 //! synchronises back references for the given object basing on the collected data
266 void synchronizeBackRefsForObject(
267 const std::set<std::shared_ptr<ModelAPI_Attribute>>& theNewRefs, ObjectPtr theObject);
269 /// Just removes all features without touching the document data (to be able undo)
270 virtual void eraseAllFeatures();
272 // Check whether the pre-image of the result had user-defined name.
273 // If yes, return this name.
274 bool hasCustomName(DataPtr theFeatureData,
277 std::string& theParentName) const;
279 /// Return object representing a folder or empty pointer
280 ObjectPtr folder(TDF_Label theLabel) const;
283 TDF_Label myMain; ///< main label of the data storage
285 DocumentPtr myDoc; ///< doc,ument, owner of this objects manager: needed for events creation
287 /// All managed features (not only in history of OB)
288 /// For optimization mapped by labels
289 NCollection_DataMap<TDF_Label, FeaturePtr> myFeatures;
292 NCollection_DataMap<TDF_Label, ObjectPtr> myFolders;
294 /// Map from group id to the array that contains all objects located in history.
295 /// Each array is updated by demand from scratch, by browing all the features in the history.
296 std::map<std::string, std::vector<ObjectPtr> > myHistory;
298 friend class Model_Document;
299 friend class Model_Session;
300 friend class Model_Update;
301 friend class Model_AttributeReference;
302 friend class Model_AttributeRefAttr;
303 friend class Model_AttributeRefList;
304 friend class Model_AttributeSelection;
305 friend class Model_SelectionNaming;