Issue #394 Undo-ing a Sketch element

[modules/shaper.git] / src / SketchSolver / SketchSolver_Solver.h

diff --git a/src/SketchSolver/SketchSolver_Solver.h b/src/SketchSolver/SketchSolver_Solver.h
index 8a4f9964e95a7795389fc3563c538b99a22c91d2..7079f1598549d2660c1c15102dce44a84a18bba4 100644 (file)
--- a/src/SketchSolver/SketchSolver_Solver.h
+++ b/src/SketchSolver/SketchSolver_Solver.h
@@ -1,9 +1,11 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:    SketchSolver_Solver.h
 // Created: 07 May 2014
 // Author:  Artem ZHIDKOV
 
-#ifndef SketchSolver_Solver_Headerfile
-#define SketchSolver_Solver_Headerfile
+#ifndef SketchSolver_Solver_H_
+#define SketchSolver_Solver_H_
 
 #include "SketchSolver.h"
 
@@ -18,7 +20,6 @@ typedef unsigned int UINT32;
 
 #include <vector>
 
-
 #define SLVS_RESULT_EMPTY_SET -1
 
 // Unknown constraint (for error reporting)
@@ -26,17 +27,21 @@ typedef unsigned int UINT32;
 // Unknown entity
 #define SLVS_E_UNKNOWN 0
 
-
+/**
+ * The main class that performs the high-level operations for connection to the SolveSpace.
+ */
 class SketchSolver_Solver
 {
-public:
+ public:
   SketchSolver_Solver();
   ~SketchSolver_Solver();
 
   /** \brief Initialize the ID of the group
    */
   inline void setGroupID(Slvs_hGroup theGroupID)
-  { myGroupID = theGroupID; }
+  {
+    myGroupID = theGroupID;
+  }
 
   /** \brief Change array of parameters
    *  \param[in] theParameters vector of parameters
@@ -70,9 +75,9 @@ public:
    */
   bool getResult(std::vector<Slvs_Param>& theParameters);
 
-private:
+ private:
   Slvs_hGroup myGroupID;         ///< identifier of the group to be solved
-  Slvs_System myEquationsSystem; ///< set of equations for solving in SolveSpace
+  Slvs_System myEquationsSystem;  ///< set of equations for solving in SolveSpace
 };
 
 #endif