src/ModelAPI/ModelAPI_AttributeValidator.h

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