src/Model/Model_Validator.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef Model_Validator_H_
  22 #define Model_Validator_H_
  23
  24 #include <Model.h>
  25 #include <ModelAPI_Validator.h>
  26 #include <map>
  27 #include <set>
  28
  29 /**\class Model_ValidatorsFactory
  30  * \ingroup DataModel
  31  * \brief Manages the registered validators
  32  *
  33  * Allows to get a validator by the feature identifier and
  34  * the attribute identifier (if attribute is validated).
  35  * All accessible validators mustbe registered by the ID string first.
  36  * The instance of this factory can be get in the Session.
  37  * Keeps the validator objects alive and just returns one of it by request.
  38  * All the needed information is provided to the validator as an argument,
  39  * this allows to work with them independently from the feature specific object.
  40  */
  41 class Model_ValidatorsFactory : public ModelAPI_ValidatorsFactory
  42 {
  43  private:
  44   std::map<std::string, ModelAPI_Validator*> myIDs;  ///< map from ID to registered validator
  45   /// validators IDs to list of arguments
  46   typedef std::map<std::string, std::list<std::string> > AttrValidators;
  47   /// validators IDs by feature ID
  48   std::map<std::string, AttrValidators> myFeatures;
  49   /// validators IDs and arguments by feature and attribute IDs
  50   std::map<std::string, std::map<std::string, AttrValidators> > myAttrs;
  51   /// Stores the registered attributes that leads to the concealment of referenced objects in
  52   /// data tree. Map from feature kind to set of attribute IDs.
  53   std::map<std::string, std::set<std::string> > myConcealed;
  54   /// Stores the registered attributes must be checked only if the particular case is activated
  55   /// Map from feature kind to map of attribute IDs to pair
  56   // (switchId (ID of the attribute) and case Ids (possible values of the switch attribute))
  57   std::map<std::string, std::map<std::string,
  58           std::map<std::string, std::set<std::string> > > > myCases;
  59
  60  public:
  61   /// Registers the instance of the validator by the ID
  62   MODEL_EXPORT virtual void registerValidator(const std::string& theID,
  63                                               ModelAPI_Validator* theValidator);
  64
  65   /// Assigns validator to the feature
  66   MODEL_EXPORT virtual void assignValidator(const std::string& theID,
  67                                             const std::string& theFeatureID);
  68
  69   /// Assigns validator to the feature with arguments of the validator
  70   MODEL_EXPORT virtual void assignValidator(const std::string& theID,
  71                                             const std::string& theFeatureID,
  72                                             const std::list<std::string>& theArguments);
  73
  74   /// Assigns validator to the attribute of the feature
  75   MODEL_EXPORT virtual void assignValidator(const std::string& theID,
  76                                             const std::string& theFeatureID,
  77                                             const std::string& theAttrID,
  78                                             const std::list<std::string>& theArguments);
  79
  80   /// Provides a validator for the feature, returns NULL if no validator
  81   MODEL_EXPORT virtual void validators(const std::string& theFeatureID,
  82                                        Validators& theResult) const;
  83   /// Provides a validator for the attribute, returns NULL if no validator
  84   MODEL_EXPORT virtual void validators(const std::string& theFeatureID,
  85     const std::string& theAttrID, Validators& theResult) const;
  86
  87   /// Returns registered validator by its Id
  88   MODEL_EXPORT virtual const ModelAPI_Validator* validator(const std::string& theID) const;
  89
  90   /// Returns true if feature and all its attributes are valid.
  91   MODEL_EXPORT virtual bool validate(const std::shared_ptr<ModelAPI_Feature>& theFeature) const;
  92
  93   /// Returns true if the attribute is valid.
  94   MODEL_EXPORT virtual bool validate(const std::shared_ptr<ModelAPI_Attribute>& theAttribute,
  95                                      std::string& theValidator, Events_InfoMessage& theError) const;
  96
  97   /// register that this attribute in feature is not obligatory for the feature execution
  98   /// so, it is not needed for the standard validation mechanism
  99   virtual void registerNotObligatory(std::string theFeature, std::string theAttribute);
 100
 101   /// Returns true if the attribute in feature is not obligatory for the feature execution
 102   virtual bool isNotObligatory(std::string theFeature, std::string theAttribute);
 103
 104   /// register that this attribute conceals in the object browser
 105   /// all referenced features after execution
 106   virtual void registerConcealment(std::string theFeature, std::string theAttribute);
 107
 108   /// Returns true that it was registered that attribute conceals the referenced result
 109   virtual bool isConcealed(std::string theFeature, std::string theAttribute);
 110
 111   /// register the case-attribute (\a myCases set definition)
 112   virtual void registerCase(std::string theFeature, std::string theAttribute,
 113                             const std::list<std::pair<std::string, std::string> >& theCases);
 114
 115   /// Returns true if the attribute must be checked (the case is selected)
 116   virtual bool isCase(FeaturePtr theFeature, std::string theAttribute);
 117
 118
 119 protected:
 120   /// Adds the defualt validators that are usefull for all features.
 121   void addDefaultValidators(Validators& theValidators) const;
 122   /// Adds the defualt validators that are usefull for all attributes.
 123   void addDefaultAttributeValidators(Validators& theValidators) const;
 124   /// Get instance from Session
 125   Model_ValidatorsFactory();
 126
 127   friend class Model_Session;
 128 };
 129
 130 #endif