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