Fix for issue #562 : correct update by dependencies in the parameters

[modules/shaper.git] / src / ModelAPI / ModelAPI_FeatureValidator.h

diff --git a/src/ModelAPI/ModelAPI_FeatureValidator.h b/src/ModelAPI/ModelAPI_FeatureValidator.h
index 7508c7ad3d30eaf9405f6375e5546e0378267c4c..59161acbef6b9fdd8b7a208a6f831b25f875979f 100644 (file)
--- a/src/ModelAPI/ModelAPI_FeatureValidator.h
+++ b/src/ModelAPI/ModelAPI_FeatureValidator.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModelAPI_FeatureValidator.h
 // Created:     8 Jul 2014
 // Author:      Vitaly SMETANNIKOV
@@ -8,14 +10,25 @@
 #include "ModelAPI.h"
 #include "ModelAPI_Validator.h"
 
+/**\class ModelAPI_FeatureValidator
+ * \ingroup DataModel
+ * \brief The geneneric validator for the whole feature.
+ *
+ * Can be redefined for some specific feature, but by default for each feature this validator is
+ * used: it checks each argument of the feature and if one of it is not valid (and obligatory),
+ * the hole feature is invalid.
+ */
 class ModelAPI_FeatureValidator : public ModelAPI_Validator
 {
  public:
   /// Returns true if feature and/or attributes are valid
   /// \param theFeature the validated feature
-  /// \param theAttr the validated attribute ID, empty string of feature is validated
   /// \param theArguments list of string, feature attribute names: dependent attributes
-  virtual bool isValid(const boost::shared_ptr<ModelAPI_Feature>& theFeature) const = 0;
+  virtual bool isValid(const std::shared_ptr<ModelAPI_Feature>& theFeature,
+    const std::list<std::string>& theArguments) const = 0;
+
+  /// Returns true if the attribute in feature is not obligatory for the feature execution
+  virtual bool isNotObligatory(std::string theFeature, std::string theAttribute) = 0;
 };
 
 #endif