Salome HOME
Source documentation updated. Obsolete files removed
[modules/shaper.git] / src / PartSet / PartSet_Validators.h
index 556c2ce06d4e15888c25c59c964d14ddb7913f6c..23706f81ccc27b286f3f44df3409f261e483b027 100644 (file)
@@ -11,8 +11,7 @@
 
 #include <ModuleBase_SelectionValidator.h>
 #include <ModuleBase_ISelection.h>
-#include <ModelAPI_RefAttrValidator.h>
-#include <ModelAPI_ResultValidator.h>
+#include <ModelAPI_AttributeValidator.h>
 
 /*
  * Selector validators
 
 //! \ingroup Validators
 //! A class to validate a selection for Distance constraint operation
-class PartSet_DistanceValidator : public ModuleBase_SelectionValidator
+class PartSet_DistanceSelection : public ModuleBase_SelectionValidator
 {
- public:
+ protected:
   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
 };
 
 //! \ingroup Validators
 //! A class to validate a selection for Length constraint operation
-class PartSet_LengthValidator : public ModuleBase_SelectionValidator
+class PartSet_LengthSelection : public ModuleBase_SelectionValidator
 {
- public:
+ protected:
   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
 };
 
 //! \ingroup Validators
 //! A class to validate a selection for Perpendicular constraint operation
-class PartSet_PerpendicularValidator : public ModuleBase_SelectionValidator
+class PartSet_PerpendicularSelection : public ModuleBase_SelectionValidator
 {
- public:
+ protected:
   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
 };
 
 //! \ingroup Validators
-//! A class to validate a selection for Perpendicular constraint operation
-class PartSet_ParallelValidator : 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;
 };
 
 //! \ingroup Validators
-//! A class to validate a selection for Perpendicular constraint operation
-class PartSet_RadiusValidator : 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;
 };
 
 //! \ingroup Validators
-//! A class to validate a selection for Perpendicular constraint operation
-class PartSet_RigidValidator : 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;
+};
+
+
+//! \ingroup Validators
+//! A class to validate a selection for coincedence constraint operation
+class PartSet_CoincidentSelection : public ModuleBase_SelectionValidator
+{
+ protected:
+  PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
+};
+
+//! \ingroup Validators
+//! A class to validate a selection for Horizontal and Vertical constraints operation
+class PartSet_HVDirSelection : public ModuleBase_SelectionValidator
+{
+ protected:
+  PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
+};
+
+//! \ingroup Validators
+//! A class to validate a selection for Tangential constraints operation
+class PartSet_TangentSelection : public ModuleBase_SelectionValidator
+{
+ 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;
 };
 
+////////////// Attribute validators ////////////////
+
+
 /**
 * \ingroup Validators
 * A validator which checks that objects selected for feature attributes are different (not the same)
 */
-class PartSet_DifferentObjectsValidator : public ModelAPI_RefAttrValidator
+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;
-
-protected:
-  //! Casts the attribute to an attribute kind and obtains an object value if it is possible
-  //! \param theAttribute a source attribute to find object
-  //! \return an attribute object or NULL
-  ObjectPtr getObject(const AttributePtr& theAttribute) const;
-
-  //! 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;
+                       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;
+
 };
 
 /**
 * \ingroup Validators
 * A validator which checks that objects selected for feature attributes are different (not the same)
 */
-class PartSet_SketchEntityValidator : public ModelAPI_RefAttrValidator
+class PartSet_SketchEntityValidator : public ModelAPI_AttributeValidator
 {
  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;
 };
 
-/**
-* \ingroup Validators
-* A Validator which validates tha selected object is a Sketch
-*/
-class PartSet_SketchValidator : public ModelAPI_ResultValidator
+/**\class PartSet_CoincidentAttr
+ * \ingroup Validators
+ * \brief Validator to check whether there is a coincident constraint between
+ * the attribute and attribute of argument.
+ */
+class PartSet_CoincidentAttr : public ModelAPI_AttributeValidator
 {
  public:
-   /// Returns True if the given object is a sketch
-   /// \param theObject an object
-  virtual bool isValid(const ObjectPtr theObject) const;
+  //! 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,
+                       std::string& theError) const;
 };
 
-#endif
\ No newline at end of file
+
+#endif