src/CollectionPlugin/CollectionPlugin_Validators.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 CollectionPlugin_Validators_H
  22 #define CollectionPlugin_Validators_H
  23
  24 #include "CollectionPlugin.h"
  25 #include <ModelAPI_FeatureValidator.h>
  26
  27 /**\class SketchPlugin_SolverErrorValidator
  28 * \ingroup Validators
  29 * \brief Validator for the solver error.
  30 *
  31 * Simply checks that solver error attribute is empty. Returns the attribute value as an error.
  32 */
  33 class CollectionPlugin_FieldValidator : public ModelAPI_FeatureValidator
  34 {
  35 public:
  36   //! returns true if there are no solver errors
  37   //! \param theFeature the checked feature
  38   //! \param theArguments arguments of the feature (not used)
  39   //! \param theError error message
  40   virtual bool isValid(const FeaturePtr& theFeature,
  41     const std::list<std::string>& theArguments,
  42     Events_InfoMessage& theError) const;
  43 };
  44
  45 #endif