-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File: PlaneGCSSolver_Solver.h
-// Created: 14 Dec 2014
-// Author: Artem ZHIDKOV
+// Copyright (C) 2014-2023 CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
#ifndef PlaneGCSSolver_Solver_H_
#define PlaneGCSSolver_Solver_H_
-#include <SketchSolver_ISolver.h>
#include <PlaneGCSSolver_Defs.h>
+#include <PlaneGCSSolver_ConstraintWrapper.h>
#include <GCS.h>
-/**
- * The main class that performs the high-level operations for connection to the PlaneGCS.
- */
-class PlaneGCSSolver_Solver : public SketchSolver_ISolver
+/// \brief The main class that performs the high-level operations for connection to the PlaneGCS.
+class PlaneGCSSolver_Solver
{
public:
- PlaneGCSSolver_Solver() {}
+ /// The result of constraints solution
+ enum SolveStatus {
+ STATUS_OK,
+ STATUS_INCONSISTENT,
+ STATUS_EMPTYSET,
+ STATUS_DEGENERATED,
+ STATUS_FAILED, // set if no one other status is applicable
+ STATUS_UNKNOWN // set for newly created groups
+ };
+
+ PlaneGCSSolver_Solver();
~PlaneGCSSolver_Solver();
/// \brief Clear system of equations
void clear();
/// \brief Add constraint to the system of equations
- void addConstraint(GCSConstraintPtr theConstraint);
-
- /// \brief Remove constraint from the system of equations
- void removeConstraint(GCSConstraintPtr theConstraint);
-
- /// \brief Initialize list of unknowns
- void setParameters(const GCS::VEC_pD& theParams)
- { myParameters = theParams; }
-
- /// \brief Set list of IDs of tangent constraints
- ///
- /// Workaround to avoid incorrect report about redundant constraints
- /// if an arc is already smoothly connected to a line.
- void setTangent(const GCS::SET_I& theTangentIDs)
- { myTangent = theTangentIDs; }
-
- /** \brief Solve the set of equations
- * \return identifier whether solution succeeded
- */
- virtual SketchSolver_SolveStatus solve();
-
- /// \brief Prepare for solving. Store initial values of parameters for undo
- virtual void prepare()
- { /* do nothing */ }
+ /// \param[in] theMultiConstraintID ID of the multi constraint which may consists of
+ /// several primitive constraints
+ /// \param[in] theConstraints list of primitive constraints
+ void addConstraint(const ConstraintID& theMultiConstraintID,
+ const std::list<GCSConstraintPtr>& theConstraints);
+
+ /// \brief Remove constraints from the system of equations
+ void removeConstraint(const ConstraintID& theID);
+
+ /// \brief Initialize memory for new solver's parameter
+ double* createParameter();
+ /// \brief Add parameters created elsewhere
+ void addParameters(const GCS::SET_pD& theParams);
+ /// \brief Release memory occupied by parameters
+ void removeParameters(const GCS::SET_pD& theParams);
+
+ /// \brief Preliminary initialization of solver (useful for moving a feature).
+ /// When called, the solve() method does not reinitialize a set of constraints.
+ void initialize();
+
+ /// \brief Solve the set of equations
+ /// \return identifier whether solution succeeded
+ SolveStatus solve();
/// \brief Revert solution to initial values
- virtual void undo();
+ void undo();
/// \brief Check the constraint is conflicted with others
- virtual bool isConflicting(const ConstraintID& theConstraint) const;
+ bool isConflicting(const ConstraintID& theConstraint) const;
+
+ /// \brief Check conflicting/redundant constraints and DoF
+ void diagnose(const GCS::Algorithm& theAlgo = GCS::DogLeg);
+
+ /// \brief Return the list of modifiable parameters
+ void getFreeParameters(GCS::SET_pD& theFreeParams);
/// \brief Degrees of freedom
- virtual int dof() const;
+ int dof();
private:
- void collectConflicting();
+ void collectConflicting(bool withRedundant = true);
+
+ /// \brief Add fictive constraint if the sketch contains temporary constraints only
+ void addFictiveConstraintIfNecessary();
+ /// \brief Remove previously added fictive constraint
+ void removeFictiveConstraint();
private:
- GCS::VEC_pD myParameters; ///< list of unknowns
- std::set<GCS::Constraint*> myConstraints; ///< list of constraints already processed by the system
- GCS::System myEquationSystem; ///< set of equations for solving in FreeGCS
+ typedef std::map<ConstraintID, std::list<GCSConstraintPtr> > ConstraintMap;
+
+ GCS::VEC_pD myParameters; ///< list of unknowns
+ ConstraintMap myConstraints; ///< list of constraints
- GCS::VEC_I myConflictingIDs; ///< list of IDs of conflicting constraints
- bool myConfCollected; ///< specifies the conflicting constraints are already collected
+ std::shared_ptr<GCS::System> myEquationSystem; ///< set of equations for solving in FreeGCS
+ bool myDiagnoseBeforeSolve; ///< is the diagnostic necessary
+ bool myInitilized; ///< is the system already initialized
- GCS::SET_I myTangent; ///< list of tangent IDs to check incorrect redundant constraints
+ GCS::SET_I myConflictingIDs; ///< list of IDs of conflicting constraints
+ /// specifies the conflicting constraints are already collected
+ bool myConfCollected;
+
+ int myDOF; ///< degrees of freedom
+
+ GCS::Constraint* myFictiveConstraint;
};
+typedef std::shared_ptr<PlaneGCSSolver_Solver> SolverPtr;
+
#endif
