-// File: ModelAPI_Tools.h
-// Created: 06 Aug 2014
-// Author: Vitaly Smetannikov
-
-#ifndef ModelAPI_Tools_HeaderFile
-#define ModelAPI_Tools_HeaderFile
-
-#include "ModelAPI.h"
-#include <ModelAPI_Result.h>
-#include <GeomAPI_Shape.h>
-
-namespace ModelAPI_Tools {
-/// Returns shape from the given Result object
-MODELAPI_EXPORT boost::shared_ptr<GeomAPI_Shape> shape(const ResultPtr& theResult);
-}
-;
-
-#endif
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D\r
+\r
+// File: ModelAPI_Tools.h\r
+// Created: 06 Aug 2014\r
+// Author: Vitaly Smetannikov\r
+\r
+#ifndef ModelAPI_Tools_HeaderFile\r
+#define ModelAPI_Tools_HeaderFile\r
+\r
+#include "ModelAPI.h"\r
+\r
+#include <ModelAPI_CompositeFeature.h>\r
+#include <ModelAPI_Document.h>\r
+#include <ModelAPI_Feature.h>\r
+#include <ModelAPI_Result.h>\r
+#include <ModelAPI_ResultParameter.h>\r
+#include <ModelAPI_ResultCompSolid.h>\r
+\r
+#include <GeomAPI_Shape.h>\r
+\r
+#include <vector>\r
+#include <map>\r
+#include <set>\r
+\r
+namespace ModelAPI_Tools {\r
+/// Returns shape from the given Result object\r
+MODELAPI_EXPORT std::shared_ptr<GeomAPI_Shape> shape(const ResultPtr& theResult);\r
+\r
+/// Creates a container of shape of the feature results satisfied the given shape type\r
+/// \param theFeature a source feature\r
+/// \param theType shape type\r
+/// \param an output container for shapes\r
+MODELAPI_EXPORT void shapesOfType(const FeaturePtr& theFeature,\r
+ const GeomAPI_Shape::ShapeType& theType,\r
+ std::set<GeomShapePtr>& theShapes);\r
+\r
+/*! Returns the feature error generated according to feature error and exec state\r
+ * \param theFeature a feature\r
+ * \return error value or empty string\r
+ */\r
+MODELAPI_EXPORT std::string getFeatureError(const FeaturePtr& theFeature);\r
+\r
+/*!\r
+ * Searches for variable with name \param theName in \param theDocument. \r
+ * If found, set it value in the \param outValue and returns true.\r
+ * theSearcher must be located later in the history than the found variable.\r
+ */\r
+MODELAPI_EXPORT bool findVariable(const DocumentPtr& theDocument, FeaturePtr theSearcher,\r
+ const std::string& theName, double& outValue, ResultParameterPtr& theParam);\r
+\r
+/*!\r
+ * Searches for variable with name \param theName in the active document (Part), when\r
+ * in the root document (PartSet). If found, set it value in the \param outValue\r
+ * and returns true. If \param theDocument is empty active document is used.\r
+ * theSearcher must be located later in the history than the found variable.\r
+ */\r
+MODELAPI_EXPORT bool findVariable(FeaturePtr theSearcher, const std::string& theName,\r
+ double& outValue, ResultParameterPtr& theParam,\r
+ const DocumentPtr& theDocument = DocumentPtr());\r
+\r
+/*!\r
+ * Returns the values of the next random color. The values are in range [0, 255]\r
+ * \param theValues a container of component of RGB value: red, green, blue\r
+ */\r
+MODELAPI_EXPORT void findRandomColor(std::vector<int>& theValues);\r
+\r
+/*!\r
+ * Searches for Part result that contains the reference to the given document.\r
+ * The result must be presented in the tree.\r
+ * \param theMain document that contains the searched feature\r
+ * \param theSub document that is searched, the resulting feature references to it\r
+ * \returns null if not found\r
+ */\r
+MODELAPI_EXPORT ResultPtr findPartResult(const DocumentPtr& theMain, const DocumentPtr& theSub);\r
+\r
+/*!\r
+ * Searches for Part the feature that contains in result the reference to the given document.\r
+ * The result may be disabled.\r
+ * \param theMain document that contains the searched feature\r
+ * \param theSub document that is searched, the resulting feature references to it\r
+ * \returns null if not found\r
+ */\r
+MODELAPI_EXPORT FeaturePtr findPartFeature(const DocumentPtr& theMain, const DocumentPtr& theSub);\r
+\r
+/*!\r
+ * Returns the composite feature - parent of this feature.\r
+ * \param theFeature the sub-element of composite\r
+ * \returns null if it is not sub-element of composite\r
+ */\r
+MODELAPI_EXPORT CompositeFeaturePtr compositeOwner(const FeaturePtr& theFeature);\r
+\r
+/*!\r
+ * Returns the compsolid result - parent of this result.\r
+ * \param theSub the sub-element of comp-solid\r
+ * \returns null if it is not sub-element of composite\r
+ */\r
+MODELAPI_EXPORT ResultCompSolidPtr compSolidOwner(const ResultPtr& theSub);\r
+\r
+/*!\r
+* Returns true if the result contains a not empty list of sub results. It processes result compsolid.\r
+* \param theResult a result object\r
+* \returns boolean value\r
+*/\r
+MODELAPI_EXPORT bool hasSubResults(const ResultPtr& theResult);\r
+\r
+/*!\r
+* Adds the results of the given feature to theResults list: including disabled and sub-results\r
+*/\r
+MODELAPI_EXPORT void allResults(const FeaturePtr& theFeature, std::list<ResultPtr>& theResults);\r
+\r
+/*!\r
+ Returns true if there are no parts in the document, which are not activated\r
+ \param theNotActivatedNames out string which contains not activated names\r
+ \return a boolean value\r
+ */\r
+MODELAPI_EXPORT bool allDocumentsActivated(std::string& theNotActivatedNames);\r
+\r
+\r
+/*! Removes features from the document\r
+* \param theFeatures a list of features to be removed\r
+* \param theFlushRedisplay a boolean value if the redisplay signal should be flushed\r
+* \return true if at least one feature is removed\r
+*/\r
+MODELAPI_EXPORT bool removeFeaturesAndReferences(const std::set<FeaturePtr>& theFeatures,\r
+ const bool theFlushRedisplay = false,\r
+ const bool theUseComposite = false,\r
+ const bool theUseRecursion = true);\r
+\r
+/*! Removes features from the document\r
+* \param theFeatures a list of features to be removed\r
+* \param theFlushRedisplay a boolean value if the redisplay signal should be flushed\r
+* \return true if at least one feature is removed\r
+*/\r
+MODELAPI_EXPORT bool removeFeatures(const std::set<FeaturePtr>& theFeatures,\r
+ const bool theFlushRedisplay);\r
+\r
+/*! Build a map of references for the given set of features\r
+* \param theFeatures a list of features\r
+* \param theReferences a map of all references to the features\r
+* \param theUseComposite state if the composite features of the reference should be in the map\r
+* \param theUseRecursion state if references for features out of the sources feature\r
+ list are put into the result container. E.g. if theFeatures contains "Sketch_2", map will\r
+ contain references to this feature also.\r
+*/\r
+MODELAPI_EXPORT void findAllReferences(const std::set<FeaturePtr>& theFeatures,\r
+ std::map<FeaturePtr, std::set<FeaturePtr> >& theReferences,\r
+ const bool theUseComposite = true,\r
+ const bool theUseRecursion = true);\r
+\r
+/*! In the map of references find all features referenced to the source feature\r
+* \param theFeatures a list of features to find references\r
+* \param theReferences a map of all references to the features\r
+* \param theFeaturesRefsTo an out list of referenced features\r
+*/\r
+MODELAPI_EXPORT void findRefsToFeatures(const std::set<FeaturePtr>& aFeatures,\r
+ const std::map<FeaturePtr, std::set<FeaturePtr> >& aReferences,\r
+ std::set<FeaturePtr>& aFeaturesRefsTo);\r
+\r
+/*! Finds referenced of the feature to objects and collects concealed results.\r
+* \param theFeatures a model feature\r
+* \param theResults container for concealed results. It has no duplications\r
+*/\r
+MODELAPI_EXPORT void getConcealedResults(const FeaturePtr& theFeature,\r
+ std::list<std::shared_ptr<ModelAPI_Result> >& theResults);\r
+}\r
+\r
+#endif\r
