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 //! Moves the feature to make it after the given one in the history.
55 void moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis);
57 //! Returns the existing feature by the label
58 //! \param theLabel base label of the feature
59 FeaturePtr feature(TDF_Label theLabel) const;
61 //! Returns the existing object: result or feature
62 //! \param theLabel base label of the object
63 ObjectPtr object(TDF_Label theLabel);
65 //! Returns the first found object in the group by the object name
66 //! \param theGroupID group that contains an object
67 //! \param theName name of the object to search
68 //! \returns null if such object is not found
69 std::shared_ptr<ModelAPI_Object> objectByName(
70 const std::string& theGroupID, const std::string& theName);
72 //! Returns the result by the result name
73 ResultPtr findByName(const std::string theName);
76 //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
77 //! \param theObject object of this document
78 //! \returns index started from zero, or -1 if object is invisible or belongs to another document
79 const int index(std::shared_ptr<ModelAPI_Object> theObject);
81 //! Returns the feature in the group by the index (started from zero)
82 //! \param theGroupID group that contains a feature
83 //! \param theIndex zero-based index of feature in the group
84 ObjectPtr object(const std::string& theGroupID, const int theIndex);
86 //! Returns the number of features in the group
87 int size(const std::string& theGroupID);
89 ///! Returns all (and disabled) results of the given type. Not fast method (iterates all features).
90 void allResults(const std::string& theGroupID, std::list<ResultPtr>& theResults);
92 //! Returns the number of all features: in the history or not
93 int numInternalFeatures();
94 //! Returns the feature by zero-based index: features in the history or not
95 std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex);
97 /// Creates a construction cresults
98 std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
99 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
100 /// Creates a body results
101 std::shared_ptr<ModelAPI_ResultBody> createBody(
102 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
103 /// Creates a part results
104 std::shared_ptr<ModelAPI_ResultPart> createPart(
105 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
106 /// Creates a group results
107 std::shared_ptr<ModelAPI_ResultGroup> createGroup(
108 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
110 std::shared_ptr<ModelAPI_ResultParameter> createParameter(
111 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
113 //! Returns a feature by result (owner of result)
114 std::shared_ptr<ModelAPI_Feature>
115 feature(const std::shared_ptr<ModelAPI_Result>& theResult);
117 //! Sets the owner of this manager
118 void setOwner(DocumentPtr theDoc);
120 //! Returns the owner of this manager
121 DocumentPtr owner() {return myDoc;}
123 //! Deletes all managed features wit hemmitting of corresponded signal
128 //! Returns (creates if needed) the features label
129 TDF_Label featuresLabel() const;
131 //! Initializes feature with a unique name in this group (unique name is generated as
132 //! feature type + "_" + index
133 void setUniqueName(FeaturePtr theFeature);
135 //! Synchronizes myFeatures list with the updated document
136 //! \param theMarkUpdated causes the "update" event for all features
137 //! \param theUpdateReferences causes the update of back-references
138 //! \param theFlush makes flush all events in the end of all modifications of this method
139 void synchronizeFeatures(const bool theMarkUpdated, const bool theUpdateReferences,
140 const bool theFlush);
141 //! Synchronizes the BackReferences list in Data of Features and Results
142 void synchronizeBackRefs();
144 //! Creates manager on the OCAF document main label
145 Model_Objects(TDF_Label theMainLab);
147 //! Initializes the data fields of the feature
148 void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag);
150 //! Allows to store the result in the data tree of the document (attaches 'data' of result to tree)
151 void storeResult(std::shared_ptr<ModelAPI_Data> theFeatureData,
152 std::shared_ptr<ModelAPI_Result> theResult,
153 const int theResultIndex = 0);
155 //! returns the label of result by index; creates this label if it was not created before
156 TDF_Label resultLabel(const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex);
158 //! Updates the results list of the feature basing on the current data tree
159 void updateResults(FeaturePtr theFeature);
161 /// Internally makes document know that feature was removed or added in history after creation
162 void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject);
164 /// Internally makes document know that feature was removed or added in history after creation
165 void updateHistory(const std::string theGroup);
167 /// Clears the history arrays related to this object
168 void clearHistory(ObjectPtr theObj);
170 /// Creates the history: up to date with the current state
171 void createHistory(const std::string& theGroupID);
173 /// Returns to the next (from the history point of view) feature, any: invisible or disabled
174 /// \param theReverse if it is true, iterates in reverced order (next becomes previous)
175 FeaturePtr nextFeature(FeaturePtr theCurrent, const bool theReverse = false);
176 /// Returns to the first (from the history point of view) feature, any: invisible or disabled
177 FeaturePtr firstFeature();
178 /// Returns to the last (from the history point of view) feature, any: invisible or disabled
179 FeaturePtr lastFeature();
181 /// Returns the result group identifier of the given feature (for this at least one result must
182 /// be created before)
183 std::string featureResultGroup(FeaturePtr theFeature);
185 ///! Returns all features of the document including the hidden features which are not in
186 ///! history. Not very fast method, for calling once, not in big cycles.
187 std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures();
191 TDF_Label myMain; ///< main label of the data storage
193 DocumentPtr myDoc; ///< doc,ument, owner of this objects manager: needed for events creation
195 /// All managed features (not only in history of OB)
196 /// For optimization mapped by labels
197 NCollection_DataMap<TDF_Label, FeaturePtr> myFeatures;
199 /// Map from group id to the array that contains all objects located in history.
200 /// Each array is updated by demand from scratch, by browing all the features in the history.
201 std::map<std::string, std::vector<ObjectPtr> > myHistory;
203 friend class Model_Document;
204 friend class Model_Session;
205 friend class Model_Update;
206 friend class Model_AttributeReference;
207 friend class Model_AttributeRefAttr;
208 friend class Model_AttributeRefList;