Salome HOME
Error message correction for the following case, found by squish:
[modules/shaper.git] / src / ModelAPI / ModelAPI_Tools.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 // File:        ModelAPI_Tools.h
4 // Created:     06 Aug 2014
5 // Author:      Vitaly Smetannikov
6
7 #ifndef ModelAPI_Tools_HeaderFile
8 #define ModelAPI_Tools_HeaderFile
9
10 #include "ModelAPI.h"
11
12 #include <ModelAPI_CompositeFeature.h>
13 #include <ModelAPI_Document.h>
14 #include <ModelAPI_Feature.h>
15 #include <ModelAPI_Result.h>
16 #include <ModelAPI_ResultParameter.h>
17 #include <ModelAPI_ResultCompSolid.h>
18
19 #include <GeomAPI_Shape.h>
20
21 #include <vector>
22
23 namespace ModelAPI_Tools {
24 /// Returns shape from the given Result object
25 MODELAPI_EXPORT std::shared_ptr<GeomAPI_Shape> shape(const ResultPtr& theResult);
26
27 /*! Returns the feature error generated according to feature error and exec state
28  * \param theFeature a feature
29  * \return error value or empty string
30  */
31 MODELAPI_EXPORT std::string getFeatureError(const FeaturePtr& theFeature);
32
33 /*!
34  * Searches for variable with name \param theName in \param theDocument. 
35  * If found, set it value in the \param outValue and returns true.
36  */
37 MODELAPI_EXPORT bool findVariable(const DocumentPtr& theDocument, 
38                                   const std::string& theName, double& outValue, ResultParameterPtr& theParam);
39
40 /*!
41  * Searches for variable with name \param theName in the active document (Part), when
42  * in the root document (PartSet). If found, set it value in the \param outValue
43  * and returns true. If \param theDocument is empty active document is used.
44  */
45 MODELAPI_EXPORT bool findVariable(const std::string& theName, double& outValue, ResultParameterPtr& theParam,
46                                   const DocumentPtr& theDocument = DocumentPtr());
47
48 /*!
49  * Returns the values of the next random color. The values are in range [0, 255]
50  * \param theValues a container of component of RGB value: red, green, blue
51  */
52 MODELAPI_EXPORT void findRandomColor(std::vector<int>& theValues);
53
54 /*!
55  * Searches for Part result that contains the reference to the given document.
56  * \param theMain document that contains the searched feature
57  * \param theSub document that is searched, the resulting feature references to it
58  * \returns null if not found
59  */
60 MODELAPI_EXPORT ResultPtr findPartResult(const DocumentPtr& theMain, const DocumentPtr& theSub);
61
62 /*!
63  * Returns the composite feature - parent of this feature.
64  * \param theFeature the sub-element of composite
65  * \returns null if it is not sub-element of composite
66  */
67 MODELAPI_EXPORT CompositeFeaturePtr compositeOwner(const FeaturePtr& theFeature);
68
69 /*!
70  * Returns the compsolid result - parent of this result.
71  * \param theSub the sub-element of comp-solid
72  * \returns null if it is not sub-element of composite
73  */
74 MODELAPI_EXPORT ResultCompSolidPtr compSolidOwner(const ResultPtr& theSub);
75
76 /*!
77 * Returns true if the result contains a not empty list of sub results. It processes result compsolid.
78 * \param theResult a result object
79 * \returns boolean value
80 */
81 MODELAPI_EXPORT bool hasSubResults(const ResultPtr& theResult);
82
83 /*!
84 * Adds the results of the given feature to theResults list: including disabled and sub-results
85 */
86 MODELAPI_EXPORT void allResults(const FeaturePtr& theFeature, std::list<ResultPtr>& theResults);
87
88 }
89
90 #endif