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>
23 // for TDF_Label map usage
24 static Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper);
25 static Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2);
27 /**\class Model_Objects
29 * \brief Manager of objects of the document. Normally one this class corresponds to
30 * one document and just helper to manage objects (ModelAPI_Objects) inside of the document
31 * on the level of data storage.
36 //! Registers the fieature in the data structure
37 //! \param theFeature feature that must be added to the data structure
38 //! \param theAfterThis the feature will be added after this feature;
39 //! if it is null, the added feature will be the first
40 void addFeature(FeaturePtr theFeature, const FeaturePtr theAfterThis);
42 //! Return a list of features, which refers to the feature
43 //! \param theFeature a feature
44 //! \param theRefs a list of reference features
45 //! \param isSendError a flag whether the error message should be send
46 void refsToFeature(FeaturePtr theFeature,
47 std::set<FeaturePtr>& theRefs,
48 const bool isSendError = true);
50 //! Removes the feature from the document (with result)
51 //! \param theFeature a removed feature
52 void removeFeature(FeaturePtr theFeature);
54 //! Returns the existing feature by the label
55 //! \param theLabel base label of the feature
56 FeaturePtr feature(TDF_Label theLabel) const;
58 //! Returns the existing object: result or feature
59 //! \param theLabel base label of the object
60 ObjectPtr object(TDF_Label theLabel);
62 //! Returns the first found object in the group by the object name
63 //! \param theGroupID group that contains an object
64 //! \param theName name of the object to search
65 //! \returns null if such object is not found
66 std::shared_ptr<ModelAPI_Object> objectByName(
67 const std::string& theGroupID, const std::string& theName);
69 //! Returns the result by the result name
70 ResultPtr findByName(const std::string theName);
73 //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
74 //! \param theObject object of this document
75 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
76 const int index(std::shared_ptr<ModelAPI_Object> theObject);
78 //! Returns the feature in the group by the index (started from zero)
79 //! \param theGroupID group that contains a feature
80 //! \param theIndex zero-based index of feature in the group
81 ObjectPtr object(const std::string& theGroupID, const int theIndex);
83 //! Returns the number of features in the group
84 int size(const std::string& theGroupID);
86 ///! Returns all (and disabled) results of the given type. Not fast method (iterates all features).
87 void allResults(const std::string& theGroupID, std::list<ResultPtr>& theResults);
89 //! Returns the number of all features: in the history or not
90 int numInternalFeatures();
91 //! Returns the feature by zero-based index: features in the history or not
92 std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex);
94 /// Creates a construction cresults
95 std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
96 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
97 /// Creates a body results
98 std::shared_ptr<ModelAPI_ResultBody> createBody(
99 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
100 /// Creates a part results
101 std::shared_ptr<ModelAPI_ResultPart> createPart(
102 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
103 /// Creates a group results
104 std::shared_ptr<ModelAPI_ResultGroup> createGroup(
105 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
107 std::shared_ptr<ModelAPI_ResultParameter> createParameter(
108 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
110 //! Returns a feature by result (owner of result)
111 std::shared_ptr<ModelAPI_Feature>
112 feature(const std::shared_ptr<ModelAPI_Result>& theResult);
114 //! Sets the owner of this manager
115 void setOwner(DocumentPtr theDoc);
117 //! Returns the owner of this manager
118 DocumentPtr owner() {return myDoc;}
120 //! Deletes all managed features wit hemmitting of corresponded signal
125 //! Returns (creates if needed) the features label
126 TDF_Label featuresLabel() const;
128 //! Initializes feature with a unique name in this group (unique name is generated as
129 //! feature type + "_" + index
130 void setUniqueName(FeaturePtr theFeature);
132 //! Synchronizes myFeatures list with the updated document
133 //! \param theMarkUpdated causes the "update" event for all features
134 //! \param theUpdateReferences causes the update of back-references
135 //! \param theFlush makes flush all events in the end of all modifications of this method
136 void synchronizeFeatures(const bool theMarkUpdated, const bool theUpdateReferences,
137 const bool theFlush);
138 //! Synchronizes the BackReferences list in Data of Features and Results
139 void synchronizeBackRefs();
141 //! Creates manager on the OCAF document main label
142 Model_Objects(TDF_Label theMainLab);
144 //! Initializes the data fields of the feature
145 void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag);
147 //! Allows to store the result in the data tree of the document (attaches 'data' of result to tree)
148 void storeResult(std::shared_ptr<ModelAPI_Data> theFeatureData,
149 std::shared_ptr<ModelAPI_Result> theResult,
150 const int theResultIndex = 0);
152 //! returns the label of result by index; creates this label if it was not created before
153 TDF_Label resultLabel(const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex);
155 //! Updates the results list of the feature basing on the current data tree
156 void updateResults(FeaturePtr theFeature);
158 /// Internally makes document know that feature was removed or added in history after creation
159 void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject);
161 /// Internally makes document know that feature was removed or added in history after creation
162 void updateHistory(const std::string theGroup);
164 /// Clears the history arrays related to this object
165 void clearHistory(ObjectPtr theObj);
167 /// Creates the history: up to date with the current state
168 void createHistory(const std::string& theGroupID);
170 /// Returns to the next (from the history point of view) feature, any: invisible or disabled
171 /// \param theReverse if it is true, iterates in reverced order (next becomes previous)
172 FeaturePtr nextFeature(FeaturePtr theCurrent, const bool theReverse = false);
173 /// Returns to the first (from the history point of view) feature, any: invisible or disabled
174 FeaturePtr firstFeature();
175 /// Returns to the last (from the history point of view) feature, any: invisible or disabled
176 FeaturePtr lastFeature();
178 /// Returns the result group identifier of the given feature (for this at least one result must
179 /// be created before)
180 std::string featureResultGroup(FeaturePtr theFeature);
182 ///! Returns all features of the document including the hidden features which are not in
183 ///! history. Not very fast method, for calling once, not in big cycles.
184 std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures();
188 TDF_Label myMain; ///< main label of the data storage
190 DocumentPtr myDoc; ///< doc,ument, owner of this objects manager: needed for events creation
192 /// All managed features (not only in history of OB)
193 /// For optimization mapped by labels
194 NCollection_DataMap<TDF_Label, FeaturePtr> myFeatures;
196 /// Map from group id to the array that contains all objects located in history.
197 /// Each array is updated by demand from scratch, by browing all the features in the history.
198 std::map<std::string, std::vector<ObjectPtr> > myHistory;
200 friend class Model_Document;
201 friend class Model_Session;
202 friend class Model_Update;
203 friend class Model_AttributeReference;
204 friend class Model_AttributeRefAttr;
205 friend class Model_AttributeRefList;