1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: Model_Objects.h
4 // Created: 15 May 2015
5 // Author: Mikhail PONIKAROV
7 #ifndef Model_Objects_H_
8 #define Model_Objects_H_
11 #include <ModelAPI_Document.h>
12 #include <ModelAPI_Feature.h>
13 #include <ModelAPI_Result.h>
14 #include <ModelAPI_ResultParameter.h>
16 #include <TDocStd_Document.hxx>
17 #include <NCollection_DataMap.hxx>
18 #include <TDF_Label.hxx>
19 #include <TDF_LabelList.hxx>
24 // for TDF_Label map usage
25 static Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper);
26 static Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2);
28 /**\class Model_Objects
30 * \brief Manager of objects of the document. Normally one this class corresponds to
31 * one document and just helper to manage objects (ModelAPI_Objects) inside of the document
32 * on the level of data storage.
37 //! Registers the fieature in the data structure
38 //! \param theFeature feature that must be added to the data structure
39 //! \param theAfterThis the feature will be added after this feature;
40 //! if it is null, the added feature will be the first
41 void addFeature(FeaturePtr theFeature, const FeaturePtr theAfterThis);
43 //! Return a list of features, which refers to the feature
44 //! \param theFeature a feature
45 //! \param theRefs a list of reference features
46 //! \param isSendError a flag whether the error message should be send
47 void refsToFeature(FeaturePtr theFeature,
48 std::set<FeaturePtr>& theRefs,
49 const bool isSendError = true);
51 //! Removes the feature from the document (with result)
52 //! \param theFeature a removed feature
53 void removeFeature(FeaturePtr theFeature);
55 //! Moves the feature to make it after the given one in the history.
56 void moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis);
58 //! Returns the existing feature by the label
59 //! \param theLabel base label of the feature
60 FeaturePtr feature(TDF_Label theLabel) const;
62 //! Returns the existing object: result or feature
63 //! \param theLabel base label of the object
64 ObjectPtr object(TDF_Label theLabel);
66 //! Returns the first found object in the group by the object name
67 //! \param theGroupID group that contains an object
68 //! \param theName name of the object to search
69 //! \returns null if such object is not found
70 std::shared_ptr<ModelAPI_Object> objectByName(
71 const std::string& theGroupID, const std::string& theName);
73 //! Returns the result by the result name
74 ResultPtr findByName(const std::string theName);
77 //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
78 //! \param theObject object of this document
79 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
80 const int index(std::shared_ptr<ModelAPI_Object> theObject);
82 //! Returns the feature in the group by the index (started from zero)
83 //! \param theGroupID group that contains a feature
84 //! \param theIndex zero-based index of feature in the group
85 ObjectPtr object(const std::string& theGroupID, const int theIndex);
87 //! Returns the number of features in the group
88 int size(const std::string& theGroupID);
90 ///! Returns all (and disabled) results of the given type. Not fast method (iterates all features).
91 void allResults(const std::string& theGroupID, std::list<ResultPtr>& theResults);
93 //! Returns the number of all features: in the history or not
94 int numInternalFeatures();
95 //! Returns the feature by zero-based index: features in the history or not
96 std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex);
98 //! Returns feature by the id of the feature (produced by the Data "featureId" method)
99 std::shared_ptr<ModelAPI_Feature> featureById(const int theId);
102 /// Creates a construction result
103 std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
104 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
105 /// Creates a body result
106 std::shared_ptr<ModelAPI_ResultBody> createBody(
107 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
108 /// Creates a part result
109 std::shared_ptr<ModelAPI_ResultPart> createPart(
110 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
111 /// Copies a part result, keeping the reference to origin
112 std::shared_ptr<ModelAPI_ResultPart> copyPart(
113 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
114 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
115 /// Creates a group result
116 std::shared_ptr<ModelAPI_ResultGroup> createGroup(
117 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
118 /// Creates a parameter result
119 std::shared_ptr<ModelAPI_ResultParameter> createParameter(
120 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
122 //! Returns a feature by result (owner of result)
123 std::shared_ptr<ModelAPI_Feature>
124 feature(const std::shared_ptr<ModelAPI_Result>& theResult);
126 //! Sets the owner of this manager
127 void setOwner(DocumentPtr theDoc);
129 //! Returns the owner of this manager
130 DocumentPtr owner() {return myDoc;}
132 //! Deletes all managed features wit hemmitting of corresponded signal
137 //! Returns (creates if needed) the features label
138 TDF_Label featuresLabel() const;
140 //! Initializes feature with a unique name in this group (unique name is generated as
141 //! feature type + "_" + index
142 void setUniqueName(FeaturePtr theFeature);
144 //! Synchronizes myFeatures list with the updated document
145 //! \param theUpdated list of labels that are marked as modified, so featrues must be also
146 //! \param theUpdateReferences causes the update of back-references
147 //! \param theFlush makes flush all events in the end of all modifications of this method
148 void synchronizeFeatures(const TDF_LabelList& theUpdated, const bool theUpdateReferences,
149 const bool theFlush);
150 //! Synchronizes the BackReferences list in Data of Features and Results
151 void synchronizeBackRefs();
153 //! Creates manager on the OCAF document main label
154 Model_Objects(TDF_Label theMainLab);
156 //! Initializes the data fields of the feature
157 void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag);
159 //! Allows to store the result in the data tree of the document (attaches 'data' of result to tree)
160 void storeResult(std::shared_ptr<ModelAPI_Data> theFeatureData,
161 std::shared_ptr<ModelAPI_Result> theResult,
162 const int theResultIndex = 0);
164 //! returns the label of result by index; creates this label if it was not created before
165 TDF_Label resultLabel(const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex);
167 //! Updates the results list of the feature basing on the current data tree
168 void updateResults(FeaturePtr theFeature);
170 /// Internally makes document know that feature was removed or added in history after creation
171 void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject);
173 /// Internally makes document know that feature was removed or added in history after creation
174 void updateHistory(const std::string theGroup);
176 /// Clears the history arrays related to this object
177 void clearHistory(ObjectPtr theObj);
179 /// Creates the history: up to date with the current state
180 void createHistory(const std::string& theGroupID);
182 /// Returns the next (from the history point of view) feature, any: invisible or disabled
183 /// \param theCurrent previous to the resulting feature
184 /// \param theReverse if it is true, iterates in reverced order (next becomes previous)
185 FeaturePtr nextFeature(FeaturePtr theCurrent, const bool theReverse = false);
186 /// Returns to the first (from the history point of view) feature, any: invisible or disabled
187 FeaturePtr firstFeature();
188 /// Returns to the last (from the history point of view) feature, any: invisible or disabled
189 FeaturePtr lastFeature();
190 /// Returns true if theLater is in history of features creation later than theCurrent
191 bool isLater(FeaturePtr theLater, FeaturePtr theCurrent) const;
193 /// Returns the result group identifier of the given feature (for this at least one result must
194 /// be created before)
195 std::string featureResultGroup(FeaturePtr theFeature);
197 //! Returns all features of the document including the hidden features which are not in
198 //! history. Not very fast method, for calling once, not in big cycles.
199 std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures();
201 //! synchronises back references for the given object basing on the collected data
202 void synchronizeBackRefsForObject(
203 const std::set<std::shared_ptr<ModelAPI_Attribute>>& theNewRefs, ObjectPtr theObject);
206 TDF_Label myMain; ///< main label of the data storage
208 DocumentPtr myDoc; ///< doc,ument, owner of this objects manager: needed for events creation
210 /// All managed features (not only in history of OB)
211 /// For optimization mapped by labels
212 NCollection_DataMap<TDF_Label, FeaturePtr> myFeatures;
214 /// Map from group id to the array that contains all objects located in history.
215 /// Each array is updated by demand from scratch, by browing all the features in the history.
216 std::map<std::string, std::vector<ObjectPtr> > myHistory;
218 friend class Model_Document;
219 friend class Model_Session;
220 friend class Model_Update;
221 friend class Model_AttributeReference;
222 friend class Model_AttributeRefAttr;
223 friend class Model_AttributeRefList;