Salome HOME
Dump Python in the High Level Parameterized Geometry API (issue #1648)
[modules/shaper.git] / src / ModelAPI / ModelAPI_Validator.h
index 3dfb14f10cc9f4816c77bf7f00f4f9eafe36664e..c621363d5e147b15fdf43d7382f336605c88face 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModelAPI_Validator.hxx
 // Created:     2 Jul 2014
 // Author:      Mikhail PONIKAROV
@@ -6,10 +8,12 @@
 #define ModelAPI_Validator_H_
 
 #include <ModelAPI.h>
+#include <ModelAPI_Feature.h>
 #include <memory>
 #include <list>
 
 class ModelAPI_Feature;
+class Events_InfoMessage;
 
 /**\class ModelAPI_Validator
  * \ingroup DataModel
@@ -35,7 +39,7 @@ typedef std::shared_ptr<ModelAPI_Validator> ValidatorPtr;
 
 /**\class ModelAPI_ValidatorsFactory
  * \ingroup DataModel
- * \breif Manages the registered validators
+ * \brief Manages the registered validators
  *
  * Allows to get a validator by the feature identifier and 
  * the attribute identifier (if attribute is validated).
@@ -64,14 +68,14 @@ class MODELAPI_EXPORT ModelAPI_ValidatorsFactory
                                const std::string& theAttrID,
                                const std::list<std::string>& theArguments) = 0;
 
+  /// Validators is a list of pairs <Validator, list of arguments>
+  typedef std::list<std::pair<std::string, std::list<std::string> > > Validators;
   /// Provides a validator for the feature, returns NULL if no validator
   virtual void validators(const std::string& theFeatureID,
-                          std::list<ModelAPI_Validator*>& theResult,
-                          std::list<std::list<std::string> >& theArguments) const = 0;
+                          Validators& theResult) const = 0;
   /// Provides a validator for the attribute, returns NULL if no validator
   virtual void validators(const std::string& theFeatureID, const std::string& theAttrID,
-                          std::list<ModelAPI_Validator*>& theValidators,
-                          std::list<std::list<std::string> >& theArguments) const = 0;
+                          Validators& theResult) const = 0;
 
   /// Returns registered validator by its Id
   virtual const ModelAPI_Validator* validator(const std::string& theID) const = 0;
@@ -79,6 +83,10 @@ class MODELAPI_EXPORT ModelAPI_ValidatorsFactory
   /// Returns true if feature and all its attributes are valid.
   virtual bool validate(const std::shared_ptr<ModelAPI_Feature>& theFeature) const = 0;
 
+  /// Returns true if the attribute is valid.
+  virtual bool validate(const std::shared_ptr<ModelAPI_Attribute>& theAttribute,
+                        std::string& theValidator, Events_InfoMessage& theError) const = 0;
+
   /// register that this attribute in feature is not obligatory for the feature execution
   /// so, it is not needed for the standard validation mechanism
   virtual void registerNotObligatory(std::string theFeature, std::string theAttribute) = 0;
@@ -93,6 +101,26 @@ class MODELAPI_EXPORT ModelAPI_ValidatorsFactory
   /// Returns true that it was registered that attribute conceals the referenced result
   virtual bool isConcealed(std::string theFeature, std::string theAttribute) = 0;
 
+  /// Registers (by Recover feature) cancel of concealment of specific result by specific feature.
+  /// If theCanceledFeat is empty, the concealment is canceled for this result forever.
+  virtual void registerUnconcealment(std::shared_ptr<ModelAPI_Result> theUnconcealed,
+    std::shared_ptr<ModelAPI_Feature> theCanceledFeat) = 0;
+
+  /// Disables cancel of concealment of specific result by specific feature.
+  virtual void disableUnconcealment(std::shared_ptr<ModelAPI_Result> theUnconcealed,
+    std::shared_ptr<ModelAPI_Feature> theCanceledFeat) = 0;
+
+  /// Returns true if concealment is canceled.
+  virtual bool isUnconcealed(std::shared_ptr<ModelAPI_Result> theUnconcealed,
+    std::shared_ptr<ModelAPI_Feature> theCanceledFeat) = 0;
+
+  /// Register the case-attribute: this attribute is checked only if its case is selected
+  virtual void registerCase(std::string theFeature, std::string theAttribute,
+    const std::list<std::pair<std::string, std::string> >& theCases) = 0;
+
+ /// Returns true if the attribute must be checked (the case is selected)
+  virtual bool isCase(FeaturePtr theFeature, std::string theAttribute) = 0;
+
  protected:
   /// Get instance from Session
   ModelAPI_ValidatorsFactory()