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  protected:
  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  protected:
  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  protected:
  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  protected:
  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  protected:
  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  protected:
  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  protected:
  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  protected:
  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  protected:
  90   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
  91 };
  92
  93 //! \ingroup Validators
  94 //! A class to validate a selection for Fillet constraints operation
  95 class PartSet_FilletSelection : public ModuleBase_SelectionValidator
  96 {
  97  protected:
  98   PARTSET_EXPORT virtual bool isValid(const ModuleBase_ISelection* theSelection) const;
  99 };
 100
 101 ////////////// Attribute validators ////////////////
 102
 103
 104 /**
 105 * \ingroup Validators
 106 * A validator which checks that objects selected for feature attributes are different (not the same)
 107 */
 108 class PartSet_DifferentObjectsValidator : public ModelAPI_AttributeValidator
 109 {
 110  public:
 111   //! Returns true if the attribute is good for the feature attribute
 112   //! \param theAttribute an attribute
 113   //! \param theArguments a list of arguments (names of attributes to check)
 114   virtual bool isValid(const AttributePtr& theAttribute,
 115                        const std::list<std::string>& theArguments) const;
 116
 117 protected:
 118   //! Checks whethe other feature attributes has a reference to the given attribute
 119   //! \param theAttribute a source attribute to find object
 120   //! \return a boolean value
 121   bool featureHasReferences(const AttributePtr& theAttribute) const;
 122 };
 123
 124 /**
 125 * \ingroup Validators
 126 * A validator which checks that objects selected for feature attributes are different (not the same)
 127 */
 128 class PartSet_SketchEntityValidator : public ModelAPI_AttributeValidator
 129 {
 130  public:
 131   //! Returns true if the attribute is good for the feature attribute
 132   //! \param theAttribute an attribute
 133   //! \param theArguments a list of arguments (names of attributes to check)
 134   virtual bool isValid(const AttributePtr& theAttribute,
 135                        const std::list<std::string>& theArguments) const;
 136 };
 137
 138 /**\class PartSet_SameTypeAttrValidator
 139  * \ingroup Validators
 140  * \brief Validator for the tangent constraint input.
 141  *
 142  * It just checks that distance is greater than zero.
 143  */
 144 class PartSet_SameTypeAttrValidator : public ModelAPI_AttributeValidator
 145 {
 146  public:
 147   //! returns true if attribute is valid
 148   //! \param theAttribute the checked attribute
 149   //! \param theArguments arguments of the attribute
 150   virtual bool isValid(const AttributePtr& theAttribute,
 151                        const std::list<std::string>& theArguments) const;
 152 };
 153
 154 /**\class PartSet_CoincidentAttr
 155  * \ingroup Validators
 156  * \brief Validator to check whether there is a coincident constraint between
 157  * the attribute and attribute of argument.
 158  */
 159 class PartSet_CoincidentAttr : public ModelAPI_AttributeValidator
 160 {
 161  public:
 162   //! returns true if attribute is valid
 163   //! \param theAttribute the checked attribute
 164   //! \param theArguments arguments of the attribute
 165   virtual bool isValid(const AttributePtr& theAttribute,
 166                        const std::list<std::string>& theArguments) const;
 167 };
 168
 169
 170 #endif