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