Salome HOME
Constriction type for all sketch entities
[modules/shaper.git] / src / SketchSolver / SketchSolver_Constraint.h
index 0d20edd38b121b3805f0ac5cb0950d16a8935fdb..5a98e31be6f885eb03435a4ba85a71d64ad96c9e 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:    SketchSolver_Constraint.h
 // Created: 27 May 2014
 // Author:  Artem ZHIDKOV
 #include <vector>
 
 /** \class   SketchSolver_Constraint
- *  \ingroup DataModel
+ *  \ingroup Plugins
  *  \brief   Obtain information about SketchPlugin's constraint
  */
 class SketchSolver_Constraint
 {
- public:
+public:
+  /// Default constructor
   SketchSolver_Constraint();
-  SketchSolver_Constraint(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
+  /// Creates constraint to manage the given constraint from plugin
+  SketchSolver_Constraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
 
   /** \brief Compute constraint type according to SolveSpace identifiers
    *         and verify that constraint parameters are correct
    *  \param[in]  theConstraint constraint which type should be determined
    *  \return identifier of constraint type or SLVS_C_UNKNOWN if the type is wrong
    */
-  const int& getType(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
+  const int& getType(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
   /// \brief Returns the type of myConstraint member
   inline const int& getType() const
   {
@@ -41,7 +45,7 @@ class SketchSolver_Constraint
   }
 
  private:
-  boost::shared_ptr<SketchPlugin_Constraint> myConstraint;
+  std::shared_ptr<SketchPlugin_Constraint> myConstraint;
   int myType;
   std::vector<std::string> myAttributesList;
 };