1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: SketchSolver_Group.h
4 // Created: 27 May 2014
5 // Author: Artem ZHIDKOV
7 #ifndef SketchSolver_Group_H_
8 #define SketchSolver_Group_H_
10 #include "SketchSolver.h"
11 #include <SketchSolver_Constraint.h>
12 #include <SketchSolver_Storage.h>
13 #include <SketchSolver_ISolver.h>
15 #include <SketchPlugin_Constraint.h>
16 #include <ModelAPI_Feature.h>
23 typedef std::map<ConstraintPtr, SolverConstraintPtr> ConstraintConstraintMap;
25 /** \class SketchSolver_Group
27 * \brief Keeps the group of constraints which based on the same entities
29 class SketchSolver_Group
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
36 SketchSolver_Group(std::shared_ptr<ModelAPI_CompositeFeature> theWorkplane);
38 ~SketchSolver_Group();
40 /// \brief Returns group's unique identifier
41 inline const GroupID& getId() const
46 /// \brief Returns identifier of the workplane
47 inline const EntityID& getWorkplaneId() const
52 /// \brief Returns true if the group has no constraints yet
53 inline bool isEmpty() const
55 return myConstraints.empty();
58 /// \brief Check for valid sketch data
59 inline bool isWorkplaneValid() const
61 return mySketch->data() && mySketch->data()->isValid();
64 /// \brief Check the group has conflicting constraints
65 inline bool isFailed() const
67 return !myConflictingConstraints.empty();
70 /** \brief Adds or updates a constraint in the group
71 * \param[in] theConstraint constraint to be changed
72 * \return \c true if the constraint added or updated successfully
74 bool changeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
76 /** \brief Updates the data corresponding the specified feature
77 * \param[in] theFeature the feature to be updated
79 bool updateFeature(FeaturePtr theFeature);
81 /** \brief Updates the data corresponding the specified feature moved in GUI.
82 * Additional Fixed constraints are created.
83 * \param[in] theFeature the feature to be updated
84 * \return \c true, if the feature is moved
86 bool moveFeature(FeaturePtr theFeature);
88 /** \brief Verifies the feature attributes are used in this group
89 * \param[in] theFeature constraint or any other object for verification of interaction
90 * \return \c true if some of attributes are used in current group
92 bool isInteract(FeaturePtr theFeature) const;
94 /** \brief Verifies the specified feature is equal to the base workplane for this group
95 * \param[in] theWorkplane the feature to be compared with base workplane
96 * \return \c true if workplanes are the same
98 bool isBaseWorkplane(CompositeFeaturePtr theWorkplane) const;
100 /// Returns the current workplane
101 std::shared_ptr<ModelAPI_CompositeFeature> getWorkplane() const
106 /** \brief Update parameters of workplane. Should be called when Update event is coming.
107 * \return \c true if workplane updated successfully,
108 * \c false if workplane parameters are not consistent
110 bool updateWorkplane();
112 /** \brief Searches invalid features and constraints in the group and removes them
113 * \return \c false if the group several constraints were removed
117 /** \brief Add specified group to this one
118 * \param[in] theGroup group of constraint to be added
120 void mergeGroups(const SketchSolver_Group& theGroup);
122 /** \brief Cut from the group several subgroups, which are not connected to
123 * the current one by any constraint
124 * \param[out] theCuts enlarge this list by newly created groups
126 void splitGroup(std::list<SketchSolver_Group*>& theCuts);
128 /** \brief Start solution procedure if necessary and update attributes of features
129 * \return \c false when no need to solve constraints
131 bool resolveConstraints();
133 /** \brief Collect all features applicable for the sketch
134 * \param theObjects list of features
135 * \return list of bolted and sorted features
137 static std::list<FeaturePtr> selectApplicableFeatures(const std::set<ObjectPtr>& theObjects);
140 /** \brief Removes constraints from the group
141 * \param[in] theConstraint constraint to be removed
143 void removeConstraint(ConstraintPtr theConstraint);
145 /// \brief Remove all temporary constraint after computation finished
146 void removeTemporaryConstraints();
149 /** \brief Creates a workplane from the sketch parameters
150 * \param[in] theSketch parameters of workplane are the attributes of this sketch
151 * \return \c true if success, \c false if workplane parameters are not consistent
153 bool addWorkplane(CompositeFeaturePtr theSketch);
155 /// \brief Append given constraint to the group of temporary constraints
156 void setTemporary(SolverConstraintPtr theConstraint);
158 /// \brief Verifies is the feature valid
159 bool checkFeatureValidity(FeaturePtr theFeature);
161 /// \brief Notify all interested constraints that coincidence appears or removed
162 /// \param[in] theCoincidence coincidence constraint
163 void notifyCoincidenceChanged(SolverConstraintPtr theCoincidence);
166 GroupID myID; ///< Index of the group
167 EntityID myWorkplaneID; ///< Index of workplane, the group is based on
168 CompositeFeaturePtr mySketch; ///< Sketch is equivalent to workplane
169 ConstraintConstraintMap myConstraints; ///< List of constraints
170 std::set<SolverConstraintPtr> myTempConstraints; ///< List of temporary constraints
172 /// List of parametric constraints
173 std::map<AttributePtr, SolverConstraintPtr> myParametricConstraints;
175 StoragePtr myStorage; ///< Container for the set of SolveSpace constraints and their entities
177 SolverPtr mySketchSolver; ///< Solver for set of equations obtained by constraints
179 /// Result of previous solution of the set of constraints
180 SketchSolver_SolveStatus myPrevResult;
181 std::set<ObjectPtr> myConflictingConstraints; ///< List of conflicting constraints