src/PartSet/PartSet_Validators.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        PartSet_Validators.h
   4 // Created:     09 July 2014
   5 // Author:      Vitaly SMETANNIKOV
   6
   7 #ifndef PartSet_Validators_H
   8 #define PartSet_Validators_H
   9
  10 #include "PartSet.h"
  11
  12 #include <ModuleBase_SelectionValidator.h>
  13 #include <ModuleBase_ISelection.h>
  14 #include <ModelAPI_AttributeValidator.h>
  15
  16 /*
  17  * Selector validators
  18  */
  19
  20 //! \ingroup Validators
  21 //! A class to validate a selection for Distance constraint operation
  22 class PartSet_DistanceSelection : public ModuleBase_SelectionValidator
  23 {
  24  public:
  25   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
  26 };
  27
  28 //! \ingroup Validators
  29 //! A class to validate a selection for Length constraint operation
  30 class PartSet_LengthSelection : public ModuleBase_SelectionValidator
  31 {
  32  public:
  33   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
  34 };
  35
  36 //! \ingroup Validators
  37 //! A class to validate a selection for Perpendicular constraint operation
  38 class PartSet_PerpendicularSelection : public ModuleBase_SelectionValidator
  39 {
  40  public:
  41   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
  42 };
  43
  44 //! \ingroup Validators
  45 //! A class to validate a selection for Parallel constraint operation
  46 class PartSet_ParallelSelection : public ModuleBase_SelectionValidator
  47 {
  48  public:
  49   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
  50 };
  51
  52 //! \ingroup Validators
  53 //! A class to validate a selection for Radius constraint operation
  54 class PartSet_RadiusSelection : public ModuleBase_SelectionValidator
  55 {
  56  public:
  57   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
  58 };
  59
  60 //! \ingroup Validators
  61 //! A class to validate a selection for Rigid constraint operation
  62 class PartSet_RigidSelection : public ModuleBase_SelectionValidator
  63 {
  64  public:
  65   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
  66 };
  67
  68
  69 //! \ingroup Validators
  70 //! A class to validate a selection for coincedence constraint operation
  71 class PartSet_CoincidentSelection : public ModuleBase_SelectionValidator
  72 {
  73  public:
  74   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
  75 };
  76
  77 //! \ingroup Validators
  78 //! A class to validate a selection for Horizontal and Vertical constraints operation
  79 class PartSet_HVDirSelection : public ModuleBase_SelectionValidator
  80 {
  81  public:
  82   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
  83 };
  84
  85 //! \ingroup Validators
  86 //! A class to validate a selection for Tangential constraints operation
  87 class PartSet_TangentSelection : public ModuleBase_SelectionValidator
  88 {
  89  public:
  90   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
  91 };
  92
  93 ////////////// Attribute validators ////////////////
  94
  95
  96 /**
  97 * \ingroup Validators
  98 * A validator which checks that objects selected for feature attributes are different (not the same)
  99 */
 100 class PartSet_DifferentObjectsValidator : public ModelAPI_AttributeValidator
 101 {
 102  public:
 103   //! Returns true if the attribute is good for the feature attribute
 104   //! \param theAttribute an attribute
 105   //! \param theArguments a list of arguments (names of attributes to check)
 106   virtual bool isValid(const AttributePtr& theAttribute,
 107                        const std::list<std::string>& theArguments) const;
 108
 109 protected:
 110   //! Checks whethe other feature attributes has a reference to the given attribute
 111   //! \param theAttribute a source attribute to find object
 112   //! \return a boolean value
 113   bool featureHasReferences(const AttributePtr& theAttribute) const;
 114 };
 115
 116 /**
 117 * \ingroup Validators
 118 * A validator which checks that objects selected for feature attributes are different (not the same)
 119 */
 120 class PartSet_SketchEntityValidator : public ModelAPI_AttributeValidator
 121 {
 122  public:
 123   //! Returns true if the attribute is good for the feature attribute
 124   //! \param theAttribute an attribute
 125   //! \param theArguments a list of arguments (names of attributes to check)
 126   virtual bool isValid(const AttributePtr& theAttribute,
 127                        const std::list<std::string>& theArguments) const;
 128 };
 129
 130 /**\class PartSet_SameTypeAttrValidator
 131  * \ingroup Validators
 132  * \brief Validator for the tangent constraint input.
 133  *
 134  * It just checks that distance is greater than zero.
 135  */
 136 class PartSet_SameTypeAttrValidator : public ModelAPI_AttributeValidator
 137 {
 138  public:
 139   //! returns true if attribute is valid
 140   //! \param theAttribute the checked attribute
 141   //! \param theArguments arguments of the attribute
 142   virtual bool isValid(const AttributePtr& theAttribute,
 143                        const std::list<std::string>& theArguments) const;
 144 };
 145
 146
 147 #endif