Issue #2593: CEA 2018-2 Geometrical Naming

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

diff --git a/src/ModelAPI/ModelAPI_Validator.h b/src/ModelAPI/ModelAPI_Validator.h
index 06068e011c591797773219931d176935bd3811cd..e40e05536bbb58755672bb7329e52c7b24efeeb7 100644 (file)
--- a/src/ModelAPI/ModelAPI_Validator.h
+++ b/src/ModelAPI/ModelAPI_Validator.h
@@ -1,17 +1,33 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        ModelAPI_Validator.hxx
-// Created:     2 Jul 2014
-// Author:      Mikhail PONIKAROV
+// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or
+// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef ModelAPI_Validator_H_
 #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
@@ -37,7 +53,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).
@@ -66,14 +82,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;
@@ -81,6 +97,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;
@@ -95,6 +115,25 @@ 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;
 
+  /// Register the attribute as a main argument of the feature
+  virtual void registerMainArgument(std::string theFeature, std::string theAttribute) = 0;
+
+  /// Returns true is the attribute is a main argument of the feature
+  virtual bool isMainArgument(std::string theFeature, std::string theAttribute) = 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;
+
+  /// Register the selection attribute as geometrical selection
+  virtual void registerGeometricalSelection(std::string theFeature, std::string theAttribute) = 0;
+
+  /// Returns true if the attribute is a geometrical selection
+  virtual bool isGeometricalSelection(std::string theFeature, std::string theAttribute) = 0;
+
  protected:
   /// Get instance from Session
   ModelAPI_ValidatorsFactory()