1 // Copyright (C) 2014-2019 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 ModelAPI_Tools_HeaderFile
21 #define ModelAPI_Tools_HeaderFile
25 class ModelAPI_CompositeFeature;
26 class ModelAPI_Document;
27 class ModelAPI_Feature;
28 class ModelAPI_Result;
29 class ModelAPI_ResultParameter;
30 class ModelAPI_ResultBody;
40 namespace ModelAPI_Tools {
41 /// Returns shape from the given Result object
42 MODELAPI_EXPORT std::shared_ptr<GeomAPI_Shape> shape(
43 const std::shared_ptr<ModelAPI_Result>& theResult);
45 /*! Returns the feature error generated according to feature error and exec state
46 * \param theFeature a feature
47 * \return error value or empty string
49 MODELAPI_EXPORT std::string getFeatureError(const std::shared_ptr<ModelAPI_Feature>& theFeature);
52 * Searches for variable with name \param theName in \param theDocument.
53 * If found, set it value in the \param outValue and returns true.
54 * theSearcher must be located later in the history than the found variable.
56 MODELAPI_EXPORT bool findVariable(const std::shared_ptr<ModelAPI_Document>& theDocument,
57 std::shared_ptr<ModelAPI_Feature> theSearcher,
58 const std::string& theName, double& outValue,
59 std::shared_ptr<ModelAPI_ResultParameter>& theParam);
62 * Searches for variable with name \param theName in the active document (Part), when
63 * in the root document (PartSet). If found, set it value in the \param outValue
64 * and returns true. If \param theDocument is empty active document is used.
65 * theSearcher must be located later in the history than the found variable.
67 MODELAPI_EXPORT bool findVariable(std::shared_ptr<ModelAPI_Feature> theSearcher,
68 const std::string& theName,
69 double& outValue, std::shared_ptr<ModelAPI_ResultParameter>& theParam,
70 const std::shared_ptr<ModelAPI_Document>& theDocument = std::shared_ptr<ModelAPI_Document>());
73 * Searches for Part result that contains the reference to the given document.
74 * The result must be presented in the tree.
75 * \param theMain document that contains the searched feature
76 * \param theSub document that is searched, the resulting feature references to it
77 * \returns null if not found
79 MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> findPartResult(
80 const std::shared_ptr<ModelAPI_Document>& theMain,
81 const std::shared_ptr<ModelAPI_Document>& theSub);
84 * Searches for Part the feature that contains in result the reference to the given document.
85 * The result may be disabled.
86 * \param theMain document that contains the searched feature
87 * \param theSub document that is searched, the resulting feature references to it
88 * \returns null if not found
90 MODELAPI_EXPORT std::shared_ptr<ModelAPI_Feature> findPartFeature(
91 const std::shared_ptr<ModelAPI_Document>& theMain,
92 const std::shared_ptr<ModelAPI_Document>& theSub);
95 * Returns the composite feature - parent of this feature.
96 * \param theFeature the sub-element of composite
97 * \returns null if it is not sub-element of composite
99 MODELAPI_EXPORT std::shared_ptr<ModelAPI_CompositeFeature> compositeOwner(
100 const std::shared_ptr<ModelAPI_Feature>& theFeature);
103 * Returns the result - parent of this result.
104 * \param theSub the sub-element of composit result
105 * \param theRoot if it is true, returns the root father
106 * \returns null if it is not sub-element of composite
108 MODELAPI_EXPORT std::shared_ptr<ModelAPI_ResultBody>
109 bodyOwner(const std::shared_ptr<ModelAPI_Result>& theSub, const bool theRoot = false);
111 * Returns index of this result in parent (if parent exists, returned by bodyOwner)
112 * \returns zero-base index, or -1 if not found
114 MODELAPI_EXPORT int bodyIndex(const std::shared_ptr<ModelAPI_Result>& theSub);
117 * Returns true if the result contains a not empty list of sub results.
118 * It processes result compsolid.
119 * \param theResult a result object
120 * \returns boolean value
122 MODELAPI_EXPORT bool hasSubResults(const std::shared_ptr<ModelAPI_Result>& theResult);
125 * collects recursively all subs of the given result
127 MODELAPI_EXPORT void allSubs(const std::shared_ptr<ModelAPI_ResultBody>& theResult,
128 std::list<std::shared_ptr<ModelAPI_Result> >& theResults,
129 const bool theLowerOnly = false);
132 * Adds the results of the given feature to theResults list: including disabled and sub-results
134 MODELAPI_EXPORT void allResults(const std::shared_ptr<ModelAPI_Feature>& theFeature,
135 std::list<std::shared_ptr<ModelAPI_Result> >& theResults);
138 Returns true if there are no parts in the document, which are not activated
139 \param theNotActivatedNames out string which contains not activated names
140 \return a boolean value
142 MODELAPI_EXPORT bool allDocumentsActivated(std::string& theNotActivatedNames);
144 /*! Removes features from the document
145 * \param theFeatures a list of features to be removed
146 * \param theFlushRedisplay a boolean value if the redisplay signal should be flushed
147 * \return true if at least one feature is removed
149 MODELAPI_EXPORT bool removeFeaturesAndReferences(
150 const std::set<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
151 const bool theFlushRedisplay = false,
152 const bool theUseComposite = false,
153 const bool theUseRecursion = true);
155 /*! Removes features from the document
156 * \param theFeatures a list of features to be removed
157 * \param theFlushRedisplay a boolean value if the redisplay signal should be flushed
158 * \return true if at least one feature is removed
160 MODELAPI_EXPORT bool removeFeatures(
161 const std::set<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
162 const bool theFlushRedisplay);
164 /*! Build a map of references for the given set of features
165 * \param theFeatures a list of features
166 * \param theReferences a map of all references to the features
167 * \param theUseComposite state if the composite features of the reference should be in the map
168 * \param theUseRecursion state if references for features out of the sources feature
169 list are put into the result container. E.g. if theFeatures contains "Sketch_2", map will
170 contain references to this feature also.
172 MODELAPI_EXPORT void findAllReferences(
173 const std::set<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
174 std::map<std::shared_ptr<ModelAPI_Feature>,
175 std::set<std::shared_ptr<ModelAPI_Feature> > >& theReferences,
176 const bool theUseComposite = true,
177 const bool theUseRecursion = true);
179 /*! In the map of references find all features referenced to the source feature
180 * \param theFeatures a list of features to find references
181 * \param theReferences a map of all references to the features
182 * \param theFeaturesRefsTo an out list of referenced features
184 MODELAPI_EXPORT void findRefsToFeatures(
185 const std::set<std::shared_ptr<ModelAPI_Feature> >& aFeatures,
186 const std::map<std::shared_ptr<ModelAPI_Feature>,
187 std::set<std::shared_ptr<ModelAPI_Feature> > >& aReferences,
188 std::set<std::shared_ptr<ModelAPI_Feature> >& aFeaturesRefsTo);
190 /*! Finds referenced of the feature to objects and collects concealed results.
191 * \param theFeatures a model feature
192 * \param theResults container for concealed results. It has no duplications
194 MODELAPI_EXPORT void getConcealedResults(const std::shared_ptr<ModelAPI_Feature>& theFeature,
195 std::list<std::shared_ptr<ModelAPI_Result> >& theResults);
197 /*! Return the default name of the result according the features it depends or name of the feature.
198 * Return also whether the name is get from the concealing result of parent object
199 * (means that concealing result has user-defined name).
201 MODELAPI_EXPORT std::pair<std::string, bool> getDefaultName(
202 const std::shared_ptr<ModelAPI_Result>& theResult, const bool theInherited = true);
204 /*! Collect all parents for the given feature, including the Part
206 MODELAPI_EXPORT std::set<std::shared_ptr<ModelAPI_Feature> >
207 getParents(const std::shared_ptr<ModelAPI_Feature>& theFeature);