src/ModelAPI/ModelAPI_FeatureValidator.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_FeatureValidator_H
  21 #define ModelAPI_FeatureValidator_H
  22
  23 #include "ModelAPI.h"
  24 #include "ModelAPI_Validator.h"
  25
  26 /**\class ModelAPI_FeatureValidator
  27  * \ingroup DataModel
  28  * \brief The geneneric validator for the whole feature.
  29  *
  30  * Can be redefined for some specific feature, but by default for each feature this validator is
  31  * used: it checks each argument of the feature and if one of it is not valid (and obligatory),
  32  * the hole feature is invalid.
  33  */
  34 class MODELAPI_EXPORT ModelAPI_FeatureValidator : public ModelAPI_Validator
  35 {
  36  public:
  37   /// Default constructor
  38   ModelAPI_FeatureValidator();
  39   /// Virtual destructor
  40   virtual ~ModelAPI_FeatureValidator();
  41
  42   /// Returns true if feature and/or attributes are valid
  43   /// \param theFeature the validated feature
  44   /// \param theArguments list of string, feature attribute names: dependent attributes
  45   /// \param theError the error string message if validation fails
  46   virtual bool isValid(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  47                        const std::list<std::string>& theArguments,
  48                        Events_InfoMessage& theError) const = 0;
  49
  50   /// Returns true if the attribute in feature is not obligatory for the feature execution.
  51   ///Returns false by default.
  52   virtual bool isNotObligatory(std::string theFeature, std::string theAttribute);
  53 };
  54
  55 #endif