X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Tools.h;h=1d86a03cc038880cfa3668b4f8edc61dd45fce7c;hb=8476d5e088f7b1b5a414fa5e33ce99d6131929eb;hp=97b93c9d569c3bc479930c84d90125780f80b0d8;hpb=8ebc9a7d5f87057b61b174e7568e01e44571549d;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 97b93c9d5..1d86a03cc --- a/src/ModelAPI/ModelAPI_Tools.h +++ b/src/ModelAPI/ModelAPI_Tools.h @@ -24,6 +24,12 @@ namespace ModelAPI_Tools { /// Returns shape from the given Result object MODELAPI_EXPORT std::shared_ptr shape(const ResultPtr& theResult); +/*! Returns the feature error generated according to feature error and exec state + * \param theFeature a feature + * \return error value or empty string + */ +MODELAPI_EXPORT std::string getFeatureError(const FeaturePtr& theFeature); + /*! * Searches for variable with name \param theName in \param theDocument. * If found, set it value in the \param outValue and returns true. @@ -47,12 +53,22 @@ MODELAPI_EXPORT void findRandomColor(std::vector& 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 null if not found */ MODELAPI_EXPORT ResultPtr findPartResult(const DocumentPtr& theMain, const DocumentPtr& theSub); +/*! + * 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 @@ -67,6 +83,18 @@ MODELAPI_EXPORT CompositeFeaturePtr compositeOwner(const FeaturePtr& theFeature) */ 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& theResults); + } #endif