Salome HOME
Tangent presentation correction
[modules/shaper.git] / src / PartSet / PartSet_Validators.h
index eb44d6daae3eaaf8e6d1116eadcda3ecbb13f39b..0dc5f46195d640760a9d7c4b6b2f4a91a0ee8161 100644 (file)
@@ -18,6 +18,7 @@
  * Selector validators
  */
 
+//! \ingroup Validators
 //! A class to validate a selection for Distance constraint operation
 class PartSet_DistanceValidator : public ModuleBase_SelectionValidator
 {
@@ -25,6 +26,7 @@ class PartSet_DistanceValidator : public ModuleBase_SelectionValidator
   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
 {
@@ -32,6 +34,7 @@ class PartSet_LengthValidator : public ModuleBase_SelectionValidator
   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
 {
@@ -39,6 +42,7 @@ class PartSet_PerpendicularValidator : public ModuleBase_SelectionValidator
   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
 {
@@ -46,6 +50,7 @@ class PartSet_ParallelValidator : public ModuleBase_SelectionValidator
   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
 {
@@ -53,6 +58,7 @@ class PartSet_RadiusValidator : public ModuleBase_SelectionValidator
   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
 {
@@ -60,27 +66,41 @@ class PartSet_RigidValidator : public ModuleBase_SelectionValidator
   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
 };
 
+/**
+* \ingroup Validators
+* A validator which checks that objects selected for feature attributes are different (not the same)
+*/
 class PartSet_DifferentObjectsValidator : public ModelAPI_RefAttrValidator
 {
  public:
-  virtual bool isValid(const FeaturePtr& theFeature, const std::list<std::string>& theArguments,
-                       const ObjectPtr& theObject) const;
   //! Returns true if the attribute is good for the feature attribute
-  virtual bool isValid(const FeaturePtr& theFeature, const std::list<std::string>& theArguments,
-                       const AttributePtr& theAttribute) const;
-
+  //! \param theAttribute an attribute
+  //! \param theArguments a list of arguments (names of attributes to check)
   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;
 };
 
 /**
-* aValidator which validates tha selected object is a Sketch
+* \ingroup Validators
+* A Validator which validates tha selected object is a Sketch
 */
 class PartSet_SketchValidator : public ModelAPI_ResultValidator
 {
  public:
+   /// Returns True if the given object is a sketch
+   /// \param theObject an object
   virtual bool isValid(const ObjectPtr theObject) const;
 };
 
-
-#endif
+#endif
\ No newline at end of file