X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Tools.h;h=1d86a03cc038880cfa3668b4f8edc61dd45fce7c;hb=8476d5e088f7b1b5a414fa5e33ce99d6131929eb;hp=b99b9f87ed738955135c523b752f5d88b3422985;hpb=eb0cd64411cc25e50efff3f695fca2ccf8be7a85;p=modules%2Fshaper.git

diff --git a/src/ModelAPI/ModelAPI_Tools.h b/src/ModelAPI/ModelAPI_Tools.h
old mode 100644
new mode 100755
index b99b9f87e..1d86a03cc
--- a/src/ModelAPI/ModelAPI_Tools.h
+++ b/src/ModelAPI/ModelAPI_Tools.h
@@ -8,12 +8,15 @@
 #define ModelAPI_Tools_HeaderFile
 
 #include "ModelAPI.h"
-#include <ModelAPI_Result.h>
-#include <ModelAPI_ResultParameter.h>
+
+#include <ModelAPI_CompositeFeature.h>
 #include <ModelAPI_Document.h>
 #include <ModelAPI_Feature.h>
+#include <ModelAPI_Result.h>
+#include <ModelAPI_ResultParameter.h>
+#include <ModelAPI_ResultCompSolid.h>
+
 #include <GeomAPI_Shape.h>
-#include <ModelAPI_CompositeFeature.h>
 
 #include <vector>
 
@@ -21,20 +24,26 @@ namespace ModelAPI_Tools {
 /// Returns shape from the given Result object
 MODELAPI_EXPORT std::shared_ptr<GeomAPI_Shape> shape(const ResultPtr& theResult);
 
-/*!
- * Searches for variable with name \param theName in the active document (Part), when
- * in the root document (PartSet). If found, set it value in the \param outValue
- * and returns true.
+/*! Returns the feature error generated according to feature error and exec state
+ * \param theFeature a feature
+ * \return error value or empty string
  */
-MODELAPI_EXPORT bool findVariable(const std::string& theName, double& outValue, 
-  ResultParameterPtr& theParam);
+MODELAPI_EXPORT std::string getFeatureError(const FeaturePtr& theFeature);
 
 /*!
- * Searches for variable with name \param theName in the document. 
+ * Searches for variable with name \param theName in \param theDocument. 
  * If found, set it value in the \param outValue and returns true.
  */
-MODELAPI_EXPORT bool findVariable(const DocumentPtr& theDocument, const std::string& theName, 
-                                  double& outValue, ResultParameterPtr& theParam);
+MODELAPI_EXPORT bool findVariable(const DocumentPtr& theDocument, 
+                                  const std::string& theName, double& outValue, ResultParameterPtr& theParam);
+
+/*!
+ * Searches for variable with name \param theName in the active document (Part), when
+ * in the root document (PartSet). If found, set it value in the \param outValue
+ * and returns true. If \param theDocument is empty active document is used.
+ */
+MODELAPI_EXPORT bool findVariable(const std::string& theName, double& outValue, ResultParameterPtr& theParam,
+                                  const DocumentPtr& theDocument = DocumentPtr());
 
 /*!
  * Returns the values of the next random color. The values are in range [0, 255]
@@ -44,19 +53,48 @@ MODELAPI_EXPORT void findRandomColor(std::vector<int>& theValues);
 
 /*!
  * Searches for Part result that contains the reference to the given document.
+ * The result must be presented in the tree.
  * \param theMain document that contains the searched feature
  * \param theSub document that is searched, the resulting feature references to it
- * \returns numm if not found
+ * \returns null if not found
  */
 MODELAPI_EXPORT ResultPtr findPartResult(const DocumentPtr& theMain, const DocumentPtr& theSub);
 
 /*!
- * Returns the cpomposite feature - parent of this feature.
+ * Searches for Part the feature that contains in result the reference to the given document.
+ * The result may be disabled.
+ * \param theMain document that contains the searched feature
+ * \param theSub document that is searched, the resulting feature references to it
+ * \returns null if not found
+ */
+MODELAPI_EXPORT FeaturePtr findPartFeature(const DocumentPtr& theMain, const DocumentPtr& theSub);
+
+/*!
+ * Returns the composite feature - parent of this feature.
  * \param theFeature the sub-element of composite
  * \returns null if it is not sub-element of composite
  */
 MODELAPI_EXPORT CompositeFeaturePtr compositeOwner(const FeaturePtr& theFeature);
 
+/*!
+ * Returns the compsolid result - parent of this result.
+ * \param theSub the sub-element of comp-solid
+ * \returns null if it is not sub-element of composite
+ */
+MODELAPI_EXPORT ResultCompSolidPtr compSolidOwner(const ResultPtr& theSub);
+
+/*!
+* Returns true if the result contains a not empty list of sub results. It processes result compsolid.
+* \param theResult a result object
+* \returns boolean value
+*/
+MODELAPI_EXPORT bool hasSubResults(const ResultPtr& theResult);
+
+/*!
+* Adds the results of the given feature to theResults list: including disabled and sub-results
+*/
+MODELAPI_EXPORT void allResults(const FeaturePtr& theFeature, std::list<ResultPtr>& theResults);
+
 }
 
 #endif