src/Model/Model_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 email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  18 //
  19
  20 #ifndef Model_AttributeValidator_H
  21 #define Model_AttributeValidator_H
  22
  23 #include "Model.h"
  24 #include <ModelAPI_AttributeValidator.h>
  25
  26 /**\class Model_AttributeValidator
  27  * \ingroup DataModel
  28  * \brief The geneneric validator for the attribute.
  29  *
  30  * Can be redefined for some specific attributes, but by default for each attribute this validator is
  31  * used: it checks the argument and if it contains invalid expression the attribute is invalid.
  32  */
  33 class Model_AttributeValidator : public ModelAPI_AttributeValidator
  34 {
  35 public:
  36   /// \param theAttribute the checked attribute
  37   /// \param theArguments arguments of the attribute
  38   /// \param theError erros message produced by validator to the user if it fails
  39   /// \returns true if attribute is valid
  40   MODEL_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
  41                                     const std::list<std::string>& theArguments,
  42                                     Events_InfoMessage& theError) const;
  43 };
  44
  45 #endif // Model_AttributeValidator_H