src/SketchSolver/SketchSolver_Group.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:    SketchSolver_Group.h
   4 // Created: 27 May 2014
   5 // Author:  Artem ZHIDKOV
   6
   7 #ifndef SketchSolver_Group_H_
   8 #define SketchSolver_Group_H_
   9
  10 #include "SketchSolver.h"
  11 #include <SketchSolver_Constraint.h>
  12 #include <SketchSolver_Storage.h>
  13 #include <SketchSolver_ISolver.h>
  14
  15 #include <SketchPlugin_Constraint.h>
  16 #include <ModelAPI_Feature.h>
  17
  18 #include <memory>
  19 #include <list>
  20 #include <map>
  21 #include <set>
  22
  23 typedef std::map<ConstraintPtr, SolverConstraintPtr> ConstraintConstraintMap;
  24
  25 /** \class   SketchSolver_Group
  26  *  \ingroup Plugins
  27  *  \brief   Keeps the group of constraints which based on the same entities
  28  */
  29 class SketchSolver_Group
  30 {
  31  public:
  32   /** \brief New group based on specified workplane.
  33    *         Throws an exception if theWorkplane is not an object of SketchPlugin_Sketch type
  34    *  \remark Type of theSketch is not verified inside
  35    */
  36   SketchSolver_Group(std::shared_ptr<ModelAPI_CompositeFeature> theWorkplane);
  37
  38   ~SketchSolver_Group();
  39
  40   /// \brief Returns group's unique identifier
  41   inline const GroupID& getId() const
  42   {
  43     return myID;
  44   }
  45
  46   /// \brief Returns identifier of the workplane
  47   inline const EntityID& getWorkplaneId() const
  48   {
  49     return myWorkplaneID;
  50   }
  51
  52   /// \brief Returns true if the group has no constraints yet
  53   inline bool isEmpty() const
  54   {
  55     return myConstraints.empty();
  56   }
  57
  58   /// \brief Check for valid sketch data
  59   inline bool isWorkplaneValid() const
  60   {
  61     return mySketch->data() && mySketch->data()->isValid();
  62   }
  63
  64   /// \brief Verifies the constraint is complex, i.e. it needs another constraints to be created before
  65   static bool isComplexConstraint(FeaturePtr theConstraint);
  66
  67   /** \brief Adds or updates a constraint in the group
  68    *  \param[in] theConstraint constraint to be changed
  69    *  \return \c true if the constraint added or updated successfully
  70    */
  71   bool changeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
  72
  73   /** \brief Updates the data corresponding the specified feature
  74    *  \param[in] theFeature the feature to be updated
  75    */
  76   bool updateFeature(FeaturePtr theFeature);
  77
  78   /** \brief Updates the data corresponding the specified feature moved in GUI.
  79    *         Additional Fixed constraints are created.
  80    *  \param[in] theFeature the feature to be updated
  81    */
  82   void moveFeature(FeaturePtr theFeature);
  83
  84   /** \brief Verifies the feature attributes are used in this group
  85    *  \param[in] theFeature constraint or any other object for verification of interaction
  86    *  \return \c true if some of attributes are used in current group
  87    */
  88   bool isInteract(FeaturePtr theFeature) const;
  89
  90   /** \brief Verifies the specified feature is equal to the base workplane for this group
  91    *  \param[in] theWorkplane the feature to be compared with base workplane
  92    *  \return \c true if workplanes are the same
  93    */
  94   bool isBaseWorkplane(CompositeFeaturePtr theWorkplane) const;
  95
  96   /// Returns the current workplane
  97   std::shared_ptr<ModelAPI_CompositeFeature> getWorkplane() const
  98   {
  99     return mySketch;
 100   }
 101
 102   /** \brief Update parameters of workplane. Should be called when Update event is coming.
 103    *  \return \c true if workplane updated successfully, \c false if workplane parameters are not consistent
 104    */
 105   bool updateWorkplane();
 106
 107   /** \brief Searches invalid features and constraints in the group and removes them
 108    *  \return \c false if the group several constraints were removed
 109    */
 110   bool isConsistent();
 111
 112   /** \brief Add specified group to this one
 113    *  \param[in] theGroup group of constraint to be added
 114    */
 115   void mergeGroups(const SketchSolver_Group& theGroup);
 116
 117   /** \brief Cut from the group several subgroups, which are not connected to the current one by any constraint
 118    *  \param[out] theCuts enlarge this list by newly created groups
 119    */
 120   void splitGroup(std::list<SketchSolver_Group*>& theCuts);
 121
 122   /** \brief Start solution procedure if necessary and update attributes of features
 123    *  \return \c false when no need to solve constraints
 124    */
 125   bool resolveConstraints();
 126
 127   /** \brief Collect all features applicable for the sketch
 128    *  \param theObjects  list of features
 129    *  \return list of bolted and sorted features
 130    */
 131   static std::list<FeaturePtr> selectApplicableFeatures(const std::set<ObjectPtr>& theObjects);
 132
 133 protected:
 134   /** \brief Removes constraints from the group
 135    *  \param[in] theConstraint constraint to be removed
 136    */
 137   void removeConstraint(ConstraintPtr theConstraint);
 138
 139   /// \brief Remove all temporary constraint after computation finished
 140   void removeTemporaryConstraints();
 141
 142 private:
 143   /** \brief Creates a workplane from the sketch parameters
 144    *  \param[in] theSketch parameters of workplane are the attributes of this sketch
 145    *  \return \c true if success, \c false if workplane parameters are not consistent
 146    */
 147   bool addWorkplane(CompositeFeaturePtr theSketch);
 148
 149   /// \brief Append given constraint to the group of temporary constraints
 150   void setTemporary(SolverConstraintPtr theConstraint);
 151
 152   /// \brief Verifies is the feature valid
 153   bool checkFeatureValidity(FeaturePtr theFeature);
 154
 155 private:
 156   GroupID  myID; ///< Index of the group
 157   EntityID myWorkplaneID; ///< Index of workplane, the group is based on
 158   CompositeFeaturePtr mySketch; ///< Sketch is equivalent to workplane
 159   ConstraintConstraintMap myConstraints; ///< List of constraints
 160   std::set<SolverConstraintPtr> myTempConstraints; ///< List of temporary constraints
 161   std::map<AttributePtr, SolverConstraintPtr> myParametricConstraints; ///< List of parametric constraints
 162
 163   StoragePtr myStorage; ///< Container for the set of SolveSpace constraints and their entities
 164
 165   SolverPtr mySketchSolver;  ///< Solver for set of equations obtained by constraints
 166
 167   SketchSolver_SolveStatus myPrevResult; ///< Result of previous solution of the set of constraints
 168 };
 169
 170 #endif