1 // Copyright (C) 2014-2020 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 email : webmaster.salome@opencascade.com
20 #ifndef Model_Objects_H_
21 #define Model_Objects_H_
24 #include <ModelAPI_Document.h>
25 #include <ModelAPI_Feature.h>
26 #include <ModelAPI_Folder.h>
27 #include <ModelAPI_Result.h>
28 #include <ModelAPI_ResultParameter.h>
30 #include <TDocStd_Document.hxx>
31 #include <NCollection_DataMap.hxx>
32 #include <TDF_Label.hxx>
33 #include <TDF_LabelList.hxx>
38 extern int kUNDEFINED_FEATURE_INDEX;
40 /**\class Model_Objects
42 * \brief Manager of objects of the document. Normally one this class corresponds to
43 * one document and just helper to manage objects (ModelAPI_Objects) inside of the document
44 * on the level of data storage.
49 //! Registers the feature in the data structure
50 //! \param theFeature feature that must be added to the data structure
51 //! \param theAfterThis the feature will be added after this feature;
52 //! if it is null, the added feature will be the first
53 void addFeature(FeaturePtr theFeature, const FeaturePtr theAfterThis);
55 //! Return a list of features, which refers to the feature
56 //! \param theFeature a feature
57 //! \param theRefs a list of reference features
58 //! \param isSendError a flag whether the error message should be send
59 void refsToFeature(FeaturePtr theFeature,
60 std::set<FeaturePtr>& theRefs,
61 const bool isSendError = true);
63 //! Removes the feature from the document (with result)
64 //! \param theFeature a removed feature
65 void removeFeature(FeaturePtr theFeature);
67 //! Moves the feature to make it after the given one in the history.
68 void moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis);
70 //! Returns the existing feature by the label
71 //! \param theLabel base label of the feature
72 FeaturePtr feature(TDF_Label theLabel) const;
74 //! Returns the existing object: result or feature
75 //! \param theLabel base label of the object
76 ObjectPtr object(TDF_Label theLabel);
78 //! Returns the first found object in the group by the object name
79 //! \param theGroupID group that contains an object
80 //! \param theName name of the object to search
81 //! \returns null if such object is not found
82 std::shared_ptr<ModelAPI_Object> objectByName(
83 const std::string& theGroupID, const std::wstring& theName);
85 //! Returns the result by the result name
86 ResultPtr findByName(const std::wstring theName);
89 //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
90 //! \param theObject object of this document
91 //! \param theAllowFolder take into account grouping feature by folders
92 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
93 const int index(std::shared_ptr<ModelAPI_Object> theObject,
94 const bool theAllowFolder = false);
96 //! Returns the feature in the group by the index (started from zero)
97 //! \param theGroupID group that contains a feature
98 //! \param theIndex zero-based index of feature in the group
99 //! \param theAllowFolder take into account grouping feature by folders
100 ObjectPtr object(const std::string& theGroupID,
102 const bool theAllowFolder = false);
104 //! Returns the number of features in the group
105 //! \param theGroupID group of objects
106 //! \param theAllowFolder take into account grouping feature by folders
107 int size(const std::string& theGroupID, const bool theAllowFolder = false);
109 //! Returns the parent object of this child. This may be result or feature, parent of a
110 //! top result. Fast method, that uses internal data structure specifics.
111 std::shared_ptr<ModelAPI_Object> parent(const std::shared_ptr<ModelAPI_Object> theChild);
113 //! Returns all (and disabled) results of the given type.
114 //! Not fast method (iterates all features).
115 void allResults(const std::string& theGroupID, std::list<ResultPtr>& theResults);
117 //! Returns the number of all features: in the history or not
118 int numInternalFeatures();
119 //! Returns the feature by zero-based index: features in the history or not
120 std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex);
122 /// Creates a construction result
123 std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
124 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
125 /// Creates a body result
126 std::shared_ptr<ModelAPI_ResultBody> createBody(
127 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
128 /// Creates a part result
129 std::shared_ptr<ModelAPI_ResultPart> createPart(
130 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
131 /// Copies a part result, keeping the reference to origin
132 std::shared_ptr<ModelAPI_ResultPart> copyPart(
133 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
134 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
135 /// Creates a group result
136 std::shared_ptr<ModelAPI_ResultGroup> createGroup(
137 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
138 /// Creates a field result
139 std::shared_ptr<ModelAPI_ResultField> createField(
140 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
141 /// Creates a parameter result
142 std::shared_ptr<ModelAPI_ResultParameter> createParameter(
143 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
145 //! Returns a feature by result (owner of result)
146 std::shared_ptr<ModelAPI_Feature>
147 feature(const std::shared_ptr<ModelAPI_Result>& theResult);
149 /// Creates a folder (group of the features in the object browser)
150 std::shared_ptr<ModelAPI_Folder> createFolder(
151 const std::shared_ptr<ModelAPI_Feature>& theBeforeThis);
152 //! Removes the folder from the document (all features in the folder will be kept).
153 void removeFolder(std::shared_ptr<ModelAPI_Folder> theFolder);
154 //! Search a folder applicable for the list of features
155 //! (it means the list of features stored in the folder should be consequential)
156 //! \param theFeatures list of features to be added to folder
157 //! \param theBelow search the folder below the features (if \c false, search above)
158 //! \return Empty pointer if there is no applicable folder
159 std::shared_ptr<ModelAPI_Folder> findFolder(
160 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
161 const bool theBelow);
162 //! Search a folder containing the given feature.
163 //! Additionally calculates a zero-based index of the feature in this folder.
164 //! \param theFeature feature to search
165 //! \param theIndexInFolder zero-based index in the folder or -1 if the feature is top-level.
166 //! \return the folder containing the feature or empty pointer if the feature is top-level.
167 std::shared_ptr<ModelAPI_Folder> findContainingFolder(
168 const std::shared_ptr<ModelAPI_Feature>& theFeature,
169 int& theIndexInFolder);
170 //! Add a list of features to the folder. The correctness of the adding is not performed
171 //! (such checks have been done in corresponding find.. method).
172 //! \return \c true if the movement is successful
173 bool moveToFolder(const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
174 const std::shared_ptr<ModelAPI_Folder>& theFolder);
175 //! Remove features from the folder
176 //! \param theFeatures list of features to be removed
177 //! \param theBefore extract features before the folder (this parameter is applicable only
178 //! when all features in the folder are taking out,
179 //! in other cases the direction is taken automatically)
180 //! \return \c true if the features have been moved out
181 bool removeFromFolder(const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
182 const bool theBefore = true);
184 //! Sets the owner of this manager
185 void setOwner(DocumentPtr theDoc);
187 //! Returns the owner of this manager
188 DocumentPtr owner() {return myDoc;}
190 //! Deletes all managed features with emitting of corresponded signal
191 virtual ~Model_Objects();
195 //! Returns (creates if needed) the features label
196 TDF_Label featuresLabel() const;
198 //! Initializes feature with a unique name in this group (unique name is generated as
199 //! feature type + "_" + index
200 void setUniqueName(FeaturePtr theFeature);
202 //! Initializes the folder with an unique name ("Folder_" + index)
203 void setUniqueName(FolderPtr theFolder);
205 //! Synchronizes myFeatures list with the updated document
206 //! \param theUpdated list of labels that are marked as modified, so features must be also
207 //! \param theUpdateReferences causes the update of back-references
208 //! \param theExecuteFeatures requires re-execute modified persistent features
209 //! (not needed on undo/redo/abort/open)
210 //! \param theOpen - on open nothing must be re-executed, except not persistent results
211 //! \param theFlush makes flush all events in the end of all modifications of this method
212 void synchronizeFeatures(const TDF_LabelList& theUpdated, const bool theUpdateReferences,
213 const bool theOpen, const bool theExecuteFeatures, const bool theFlush);
214 //! Synchronizes the BackReferences list in Data of Features and Results
215 void synchronizeBackRefs();
217 //! Creates manager on the OCAF document main label
218 Model_Objects(TDF_Label theMainLab);
220 //! Initializes the data fields of the feature
221 void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag);
223 //! Allows to store the result in the data tree of the document
224 //! (attaches 'data' of result to tree)
225 void storeResult(std::shared_ptr<ModelAPI_Data> theFeatureData,
226 std::shared_ptr<ModelAPI_Result> theResult,
227 const int theResultIndex = 0);
229 //! returns the label of result by index; creates this label if it was not created before
230 TDF_Label resultLabel(const std::shared_ptr<ModelAPI_Data>& theFeatureData,
231 const int theResultIndex);
233 //! Updates the results list of the feature basing on the current data tree
234 //! theProcessed is used to avoid update twice (since the function is recursive)
235 void updateResults(FeaturePtr theFeature, std::set<FeaturePtr>& theProcessed);
237 /// Internally makes document know that feature was removed or added in history after creation
238 void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject);
240 /// Internally makes document know that feature was removed or added in history after creation
241 void updateHistory(const std::string theGroup);
243 /// Clears the history arrays related to this object
244 void clearHistory(ObjectPtr theObj);
246 /// Creates the history: up to date with the current state
247 void createHistory(const std::string& theGroupID);
249 /// Returns the next (from the history point of view) feature, any: invisible or disabled
250 /// \param theCurrent previous to the resulting feature
251 /// \param theReverse if it is true, iterates in reversed order (next becomes previous)
252 /// \param theIndex may be used for optimization: index of theCurrent in references array
253 FeaturePtr nextFeature(FeaturePtr theCurrent, int& theIndex, const bool theReverse = false);
254 /// Returns to the first (from the history point of view) feature, any: invisible or disabled
255 FeaturePtr firstFeature();
256 /// Returns to the last (from the history point of view) feature, any: invisible or disabled
257 FeaturePtr lastFeature();
258 /// Returns true if theLater is in history of features creation later than theCurrent
259 bool isLater(FeaturePtr theLater, FeaturePtr theCurrent) const;
261 /// Returns the next or previous label
262 /// \param theCurrent given label
263 /// \param theReverse if it is true, iterates in reversed order (next becomes previous)
264 TDF_Label nextLabel(TDF_Label theCurrent, int& theIndex, const bool theReverse = false);
266 /// Returns the result group identifier of the given feature (for this at least one result must
267 /// be created before)
268 std::string featureResultGroup(FeaturePtr theFeature);
270 //! Returns all features of the document including the hidden features which are not in
271 //! history. Not very fast method, for calling once, not in big cycles.
272 std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures();
274 //! Returns all objects of the document including the hidden features which are not in
275 //! history. Not very fast method, for calling once, not in big cycles.
276 std::list<std::shared_ptr<ModelAPI_Object> > allObjects();
278 //! synchronizes back references for the given object basing on the collected data
279 void synchronizeBackRefsForObject(
280 const std::set<std::shared_ptr<ModelAPI_Attribute>>& theNewRefs, ObjectPtr theObject);
282 /// Just removes all features without touching the document data (to be able undo)
283 virtual void eraseAllFeatures();
285 // Check whether the predefined-image of the result had user-defined name.
286 // If yes, return this name.
287 bool hasCustomName(DataPtr theFeatureData,
290 std::wstring& theParentName) const;
292 /// Return object representing a folder or empty pointer
293 const ObjectPtr& folder(TDF_Label theLabel) const;
296 TDF_Label myMain; ///< main label of the data storage
298 DocumentPtr myDoc; ///< document, owner of this objects manager: needed for events creation
300 /// All managed features (not only in history of OB)
301 /// For optimization mapped by labels
302 NCollection_DataMap<TDF_Label, FeaturePtr> myFeatures;
305 NCollection_DataMap<TDF_Label, ObjectPtr> myFolders;
307 /// Map from group id to the array that contains all objects located in history.
308 /// Each array is updated by demand from scratch, by browsing all the features in the history.
309 std::map<std::string, std::vector<ObjectPtr> > myHistory;
311 friend class Model_Document;
312 friend class Model_Session;
313 friend class Model_Update;
314 friend class Model_AttributeReference;
315 friend class Model_AttributeRefAttr;
316 friend class Model_AttributeRefList;
317 friend class Model_AttributeSelection;
318 friend class Model_SelectionNaming;