Issue #1711: Dump study/Load saved script - tuple index out of range

[modules/shaper.git] / src / Model / Model_Validator.h

diff --git a/src/Model/Model_Validator.h b/src/Model/Model_Validator.h
index cfaeb89c5ff1369c9cb184385cb82228b2869d50..bda886ec9509c4811f497a27b17456991a6857ab 100644 (file)
--- a/src/Model/Model_Validator.h
+++ b/src/Model/Model_Validator.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        Model_Validator.hxx
 // Created:     2 Jul 2014
 // Author:      Mikhail PONIKAROV
@@ -12,7 +14,7 @@
 
 /**\class Model_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).
@@ -32,6 +34,19 @@ class Model_ValidatorsFactory : public ModelAPI_ValidatorsFactory
   std::map<std::string, AttrValidators> myFeatures;
   /// validators IDs and arguments by feature and attribute IDs
   std::map<std::string, std::map<std::string, AttrValidators> > myAttrs;
+  /// Stores the registered attributes that leads to the concealment of referenced objects in 
+  /// data tree. Map from feature kind to set of attribute IDs.
+  std::map<std::string, std::set<std::string> > myConcealed;
+  /// Stored the unconcealed results and features that caused the canceled concealment (Recover).
+  /// If the feature is empty, unconcealment is persistent.
+  std::map<std::shared_ptr<ModelAPI_Result>, std::list<std::shared_ptr<ModelAPI_Feature> > >
+    myUnconcealed;
+  /// Stores the registered attributes must be checked only if the particular case is activated
+  /// Map from feature kind to map of attribute IDs to pair 
+  // (switchId (ID of the attribute) and case Ids (possible values of the switch attribute))
+  std::map<std::string, std::map<std::string,
+          std::map<std::string, std::set<std::string> > > > myCases;
+
  public:
   /// Registers the instance of the validator by the ID
   MODEL_EXPORT virtual void registerValidator(const std::string& theID,
@@ -54,30 +69,61 @@ class Model_ValidatorsFactory : public ModelAPI_ValidatorsFactory
 
   /// Provides a validator for the feature, returns NULL if no validator
   MODEL_EXPORT virtual void validators(const std::string& theFeatureID,
-                                       std::list<ModelAPI_Validator*>& theResult,
-                                       std::list<std::list<std::string> >& theArguments) const;
+                                       Validators& theResult) const;
   /// Provides a validator for the attribute, returns NULL if no validator
-  MODEL_EXPORT virtual void validators(const std::string& theFeatureID,
-                                       const std::string& theAttrID,
-                                       std::list<ModelAPI_Validator*>& theValidators,
-                                       std::list<std::list<std::string> >& theArguments) const;
+  MODEL_EXPORT virtual void validators(const std::string& theFeatureID, 
+    const std::string& theAttrID, Validators& theResult) const;
 
   /// Returns registered validator by its Id
   MODEL_EXPORT virtual const ModelAPI_Validator* validator(const std::string& theID) const;
 
   /// Returns true if feature and all its attributes are valid.
-  MODEL_EXPORT virtual bool validate(const boost::shared_ptr<ModelAPI_Feature>& theFeature) const;
+  MODEL_EXPORT virtual bool validate(const std::shared_ptr<ModelAPI_Feature>& theFeature) const;
+
+  /// Returns true if the attribute is valid.
+  MODEL_EXPORT virtual bool validate(const std::shared_ptr<ModelAPI_Attribute>& theAttribute,
+                                     std::string& theValidator, Events_InfoMessage& theError) const;
 
   /// 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);
 
+  /// Returns true if the attribute in feature is not obligatory for the feature execution
+  virtual bool isNotObligatory(std::string theFeature, std::string theAttribute);
+
   /// register that this attribute conceals in the object browser
   /// all referenced features after execution
   virtual void registerConcealment(std::string theFeature, std::string theAttribute);
 
+  /// Returns true that it was registered that attribute conceals the referenced result
+  virtual bool isConcealed(std::string theFeature, std::string theAttribute);
+
+  /// 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);
+
+  /// 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);
+
+  /// Returns true if concealment is canceled.
+  virtual bool isUnconcealed(std::shared_ptr<ModelAPI_Result> theUnconcealed,
+    std::shared_ptr<ModelAPI_Feature> theCanceledFeat);
+
+  /// register the case-attribute (\a myCases set definition)
+  virtual void registerCase(std::string theFeature, std::string theAttribute,
+                            const std::list<std::pair<std::string, std::string> >& theCases);
+
+  /// Returns true if the attribute must be checked (the case is selected)
+  virtual bool isCase(FeaturePtr theFeature, std::string theAttribute);
+
+
 protected:
-  void addDefaultValidators(std::list<ModelAPI_Validator*>& theValidators) const;
+  /// Adds the defualt validators that are usefull for all features.
+  void addDefaultValidators(Validators& theValidators) const;
+  /// Adds the defualt validators that are usefull for all attributes.
+  void addDefaultAttributeValidators(Validators& theValidators) const;
   /// Get instance from Session
   Model_ValidatorsFactory();