src/SketchPlugin/SketchPlugin_ExternalValidator.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef SketchPlugin_ExternalValidator_H
  22 #define SketchPlugin_ExternalValidator_H
  23
  24 #include <SketchPlugin.h>
  25 #include <ModelAPI_AttributeValidator.h>
  26
  27 /**\class SketchPlugin_ExternalValidator
  28  * \ingroup Validators
  29  * \brief Validator for the points selection
  30  *
  31  * Allows to select points only.
  32  */
  33 class SketchPlugin_ExternalValidator : public ModelAPI_AttributeValidator
  34 {
  35 public:
  36   /// returns true if the feature of attribute do not contain external features
  37   /// in the given attribute and
  38   /// among attributes listed in the arguments
  39   /// \param theAttribute an attribute to check
  40   /// \param theArguments a filter parameters
  41   /// \param theError error message
  42   SKETCHPLUGIN_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
  43                                            const std::list<std::string>& theArguments,
  44                                            Events_InfoMessage& theError) const;
  45
  46 protected:
  47   /// returns true if the feature of the attribute is external
  48   /// \param theAttribute an attribute to check
  49   bool isExternalAttribute(const AttributePtr& theAttribute) const;
  50 };
  51
  52 #endif