src/BuildPlugin/BuildPlugin_Validators.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        BuildPlugin_Validators.h
   4 // Created:     22 March 2016
   5 // Author:      Dmitry Bobylev
   6
   7 #ifndef BuildPlugin_Validators_H_
   8 #define BuildPlugin_Validators_H_
   9
  10 #include <ModelAPI_AttributeValidator.h>
  11 #include <ModelAPI_FeatureValidator.h>
  12
  13 /// \class BuildPlugin_ValidatorBaseForVertex
  14 /// \ingroup Validators
  15 /// \brief A validator for selection base shapes for vertex. Allows to select vertices on sketch and
  16 /// vertex objects.
  17 class BuildPlugin_ValidatorBaseForVertex: public ModelAPI_AttributeValidator
  18 {
  19 public:
  20   //! Returns true if attribute is ok.
  21   //! \param[in] theAttribute the checked attribute.
  22   //! \param[in] theArguments arguments of the attribute.
  23   //! \param[out] theError error message.
  24    virtual bool isValid(const AttributePtr& theAttribute,
  25                         const std::list<std::string>& theArguments,
  26                         std::string& theError) const;
  27 };
  28
  29 /// \class BuildPlugin_ValidatorBaseForWire
  30 /// \ingroup Validators
  31 /// \brief A validator for selection base shapes for wire. Allows to select edges on sketch and
  32 /// wires objects that are connected to already selected shapes.
  33 class BuildPlugin_ValidatorBaseForWire: public ModelAPI_AttributeValidator
  34 {
  35 public:
  36   //! Returns true if attribute is ok.
  37   //! \param[in] theAttribute the checked attribute.
  38   //! \param[in] theArguments arguments of the attribute.
  39   //! \param[out] theError error message.
  40    virtual bool isValid(const AttributePtr& theAttribute,
  41                         const std::list<std::string>& theArguments,
  42                         std::string& theError) const;
  43 };
  44
  45 #endif