Source documentation updated. Obsolete files removed

[modules/shaper.git] / src / PartSet / PartSet_Validators.h

diff --git a/src/PartSet/PartSet_Validators.h b/src/PartSet/PartSet_Validators.h
index 101bba5f90ffd0dff1a7d7e0a51661610015c24e..23706f81ccc27b286f3f44df3409f261e483b027 100644 (file)
--- a/src/PartSet/PartSet_Validators.h
+++ b/src/PartSet/PartSet_Validators.h
@@ -21,7 +21,7 @@
 //! A class to validate a selection for Distance constraint operation
 class PartSet_DistanceSelection : public ModuleBase_SelectionValidator
 {
- public:
+ protected:
   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
 };
 
@@ -29,7 +29,7 @@ class PartSet_DistanceSelection : public ModuleBase_SelectionValidator
 //! A class to validate a selection for Length constraint operation
 class PartSet_LengthSelection : public ModuleBase_SelectionValidator
 {
- public:
+ protected:
   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
 };
 
@@ -37,7 +37,7 @@ class PartSet_LengthSelection : public ModuleBase_SelectionValidator
 //! A class to validate a selection for Perpendicular constraint operation
 class PartSet_PerpendicularSelection : public ModuleBase_SelectionValidator
 {
- public:
+ protected:
   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
 };
 
@@ -45,7 +45,7 @@ class PartSet_PerpendicularSelection : public ModuleBase_SelectionValidator
 //! A class to validate a selection for Parallel constraint operation
 class PartSet_ParallelSelection : public ModuleBase_SelectionValidator
 {
- public:
+ protected:
   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
 };
 
@@ -53,7 +53,7 @@ class PartSet_ParallelSelection : public ModuleBase_SelectionValidator
 //! A class to validate a selection for Radius constraint operation
 class PartSet_RadiusSelection : public ModuleBase_SelectionValidator
 {
- public:
+ protected:
   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
 };
 
@@ -61,7 +61,7 @@ class PartSet_RadiusSelection : public ModuleBase_SelectionValidator
 //! A class to validate a selection for Rigid constraint operation
 class PartSet_RigidSelection : public ModuleBase_SelectionValidator
 {
- public:
+ protected:
   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
 };
 
@@ -70,7 +70,7 @@ class PartSet_RigidSelection : public ModuleBase_SelectionValidator
 //! A class to validate a selection for coincedence constraint operation
 class PartSet_CoincidentSelection : public ModuleBase_SelectionValidator
 {
- public:
+ protected:
   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
 };
 
@@ -78,7 +78,7 @@ class PartSet_CoincidentSelection : public ModuleBase_SelectionValidator
 //! A class to validate a selection for Horizontal and Vertical constraints operation
 class PartSet_HVDirSelection : public ModuleBase_SelectionValidator
 {
- public:
+ protected:
   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
 };
 
@@ -86,7 +86,23 @@ class PartSet_HVDirSelection : public ModuleBase_SelectionValidator
 //! A class to validate a selection for Tangential constraints operation
 class PartSet_TangentSelection : public ModuleBase_SelectionValidator
 {
- public:
+ protected:
+  PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
+};
+
+//! \ingroup Validators
+//! A class to validate a selection for Fillet constraints operation
+class PartSet_FilletSelection : public ModuleBase_SelectionValidator
+{
+ protected:
+  PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
+};
+
+//! \ingroup Validators
+//! A class to validate a selection for Angle constraints operation
+class PartSet_AngleSelection : public ModuleBase_SelectionValidator
+{
+ protected:
   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
 };
 
@@ -99,18 +115,29 @@ class PartSet_TangentSelection : public ModuleBase_SelectionValidator
 */
 class PartSet_DifferentObjectsValidator : public ModelAPI_AttributeValidator
 {
+  //! Validator possible error types
+  enum ErrorType {
+    EqualObjects,
+    EqualAttributes,
+    EqualShapes,
+    EmptyShapes
+  };
  public:
   //! Returns true if the attribute is good for the feature attribute
   //! \param theAttribute an attribute
   //! \param theArguments a list of arguments (names of attributes to check)
+  //! \param theError an output error string
   virtual bool isValid(const AttributePtr& theAttribute,
-                       const std::list<std::string>& theArguments) const;
+                       const std::list<std::string>& theArguments,
+                       std::string& theError) const;
+private:
+  //! Returns error message for the error type
+  //! \param theType a type of error
+  //! \param thEqualObjectInfo an 
+  std::string errorMessage(const PartSet_DifferentObjectsValidator::ErrorType& theType,
+                           const std::string& thEqualObject, const std::string& theFirstAttribute,
+                           const std::string& theSecondAttribute) const;
 
-protected:
-  //! Checks whethe other feature attributes has a reference to the given attribute
-  //! \param theAttribute a source attribute to find object
-  //! \return a boolean value
-  bool featureHasReferences(const AttributePtr& theAttribute) const;
 };
 
 /**
@@ -123,24 +150,27 @@ class PartSet_SketchEntityValidator : public ModelAPI_AttributeValidator
   //! Returns true if the attribute is good for the feature attribute
   //! \param theAttribute an attribute
   //! \param theArguments a list of arguments (names of attributes to check)
+  //! \param theError an output error string
   virtual bool isValid(const AttributePtr& theAttribute,
-                       const std::list<std::string>& theArguments) const;
+                       const std::list<std::string>& theArguments,
+                       std::string& theError) const;
 };
 
-/**\class PartSet_SameTypeAttrValidator
+/**\class PartSet_CoincidentAttr
  * \ingroup Validators
- * \brief Validator for the tangent constraint input.
- *
- * It just checks that distance is greater than zero.
+ * \brief Validator to check whether there is a coincident constraint between
+ * the attribute and attribute of argument.
  */
-class PartSet_SameTypeAttrValidator : public ModelAPI_AttributeValidator
+class PartSet_CoincidentAttr : public ModelAPI_AttributeValidator
 {
  public:
   //! returns true if attribute is valid
   //! \param theAttribute the checked attribute
   //! \param theArguments arguments of the attribute
+  //! \param theError an output error string
   virtual bool isValid(const AttributePtr& theAttribute,
-                       const std::list<std::string>& theArguments) const;
+                       const std::list<std::string>& theArguments,
+                       std::string& theError) const;
 };