Salome HOME
Make referenced Bodies no more displayed in the Object Browser
[modules/shaper.git] / src / ModelAPI / ModelAPI_Validator.h
index 88ab1574c31b7f49142df8c8b6783eb078555e1f..9c83a9d7e3f4c63e9dda372255a40dc0a70eaab2 100644 (file)
@@ -2,8 +2,8 @@
 // Created:     2 Jul 2014
 // Author:      Mikhail PONIKAROV
 
-#ifndef ModelAPI_Validator_HeaderFile
-#define ModelAPI_Validator_HeaderFile
+#ifndef ModelAPI_Validator_H_
+#define ModelAPI_Validator_H_
 
 #include <ModelAPI.h>
 #include <boost/shared_ptr.hpp>
@@ -24,16 +24,11 @@ class ModelAPI_Feature;
  */
 class MODELAPI_EXPORT ModelAPI_Validator
 {
-public:
+ public:
   // Make virtual destructor in order to make the class polymorphic
-  virtual ~ModelAPI_Validator() {};
-
-  /// 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 validate(const boost::shared_ptr<ModelAPI_Feature>& theFeature,
-  //  const std::string theAttr, std::list<std::string> theArguments) const = 0;
+  virtual ~ModelAPI_Validator()
+  {
+  }
 };
 
 typedef boost::shared_ptr<ModelAPI_Validator> ValidatorPtr;
@@ -45,45 +40,50 @@ typedef boost::shared_ptr<ModelAPI_Validator> ValidatorPtr;
  * Allows to get a validator by the feature identifier and 
  * the attribute identifier (if attribute is validated).
  * All accessible validators mustbe registered by the ID string first.
- * The instance of this factory can be get in the PluginManager.
+ * The instance of this factory can be get in the Session.
  * Keeps the validator objects alive and just returns one of it by request.
  * All the needed information is provided to the validator as an argument,
  * this allows to work with them independently from the feature specific object.
  */
 class MODELAPI_EXPORT ModelAPI_ValidatorsFactory
 {
-public:
+ public:
   /// Registers the instance of the validator by the ID
   virtual void registerValidator(const std::string& theID, ModelAPI_Validator* theValidator) = 0;
 
   /// Assigns validator to the feature
   virtual void assignValidator(const std::string& theID, const std::string& theFeatureID) = 0;
 
+  /// Assigns validator to the feature with arguments of the validator
+  virtual void assignValidator(const std::string& theID,
+                                            const std::string& theFeatureID,
+                                            const std::list<std::string>& theArguments) = 0;
+
   /// Assigns validator to the attribute of the feature
-  virtual void assignValidator(const std::string& theID, 
-    const std::string& theFeatureID, const std::string& theAttrID,
-    const std::list<std::string>& theArguments) = 0;
+  virtual void assignValidator(const std::string& theID, const std::string& theFeatureID,
+                               const std::string& theAttrID,
+                               const std::list<std::string>& theArguments) = 0;
 
   /// Provides a validator for the feature, returns NULL if no validator
-  virtual void validators(const std::string& theFeatureID, 
-    std::list<ModelAPI_Validator*>& theResult) const = 0;
+  virtual void validators(const std::string& theFeatureID,
+                          std::list<ModelAPI_Validator*>& theResult,
+                          std::list<std::list<std::string> >& theArguments) 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;
+  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;
 
   /// Returns registered validator by its Id
   virtual const ModelAPI_Validator* validator(const std::string& theID) const = 0;
 
-  /// Returns the result of "validate" method for attribute of validator.
-  /// If validator is not exists, returns true: everything is valid by default.
-  //virtual bool validate(
-  //  const boost::shared_ptr<ModelAPI_Feature>& theFeature, const std::string& theAttrID) const = 0;
+  /// Returns true if feature and all its attributes are valid.
+  virtual bool validate(const boost::shared_ptr<ModelAPI_Feature>& theFeature) const = 0;
 
-protected:
-  /// Get instance from PluginManager
-  ModelAPI_ValidatorsFactory() {}
+ protected:
+  /// Get instance from Session
+  ModelAPI_ValidatorsFactory()
+  {
+  }
 };
 
 #endif