src/ModelAPI/ModelAPI_AttributeValidator.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 ModelAPI_AttributeValidator_H
  22 #define ModelAPI_AttributeValidator_H
  23
  24 #include <ModelAPI.h>
  25 #include <ModelAPI_Attribute.h>
  26 #include <ModelAPI_Validator.h>
  27
  28 /**
  29  * Generic validator for any attribute of a feature.
  30  */
  31 class ModelAPI_AttributeValidator : public ModelAPI_Validator
  32 {
  33 public:
  34   //! \returns true if attribute is valid
  35   //! \param theAttribute the checked attribute
  36   //! \param theArguments arguments of the attribute
  37   //! \param theError the error string message if validation fails
  38   virtual bool isValid(const AttributePtr& theAttribute,
  39                        const std::list<std::string>& theArguments,
  40                        Events_InfoMessage& theError) const = 0;
  41
  42   MODELAPI_EXPORT ~ModelAPI_AttributeValidator();
  43 };
  44
  45 #endif