src/Model/Model_FeatureValidator.h

   1 // Copyright (C) 2014-2019  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 Model_FeatureValidator_H
  21 #define Model_FeatureValidator_H
  22
  23 #include <Model.h>
  24 #include <ModelAPI_Feature.h>
  25 #include <ModelAPI_FeatureValidator.h>
  26
  27 #include <memory>
  28 #include <set>
  29 #include <map>
  30
  31 /**\class Model_FeatureValidator
  32  * \ingroup DataModel
  33  * \brief The geneneric validator for the whole feature.
  34  *
  35  * Can be redefined for some specific feature, but by default for each feature this validator is
  36  * used: it checks each argument of the feature and if one of it is not valid (and obligatory),
  37  * the hole feature is invalid.
  38  */
  39 class Model_FeatureValidator : public ModelAPI_FeatureValidator
  40 {
  41   // not obligatory attributes, not checked for initialization
  42   std::map<std::string, std::set<std::string> > myNotObligatory;
  43 public:
  44   /// Returns true if feature and/or attributes are valid
  45   /// \param theFeature the validated feature
  46   /// \param theArguments the arguments in the configuration file for this validator
  47   /// \param theError erros message produced by validator to the user if it fails
  48   /// \returns true if feature is valid
  49   MODEL_EXPORT virtual bool isValid(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  50                                     const std::list<std::string>& theArguments,
  51                                     Events_InfoMessage& theError) const;
  52
  53   /// sets not obligatory attributes, not checked for initialization
  54   virtual void registerNotObligatory(std::string theFeature, std::string theAttribute);
  55
  56   /// Returns true if the attribute in feature is not obligatory for the feature execution
  57   virtual bool isNotObligatory(std::string theFeature, std::string theAttribute);
  58 };
  59
  60 #endif