1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: Model_Validator.hxx
5 // Author: Mikhail PONIKAROV
7 #ifndef Model_Validator_H_
8 #define Model_Validator_H_
11 #include <ModelAPI_Validator.h>
15 /**\class Model_ValidatorsFactory
17 * \brief Manages the registered validators
19 * Allows to get a validator by the feature identifier and
20 * the attribute identifier (if attribute is validated).
21 * All accessible validators mustbe registered by the ID string first.
22 * The instance of this factory can be get in the Session.
23 * Keeps the validator objects alive and just returns one of it by request.
24 * All the needed information is provided to the validator as an argument,
25 * this allows to work with them independently from the feature specific object.
27 class Model_ValidatorsFactory : public ModelAPI_ValidatorsFactory
30 std::map<std::string, ModelAPI_Validator*> myIDs; ///< map from ID to registered validator
31 /// validators IDs to list of arguments
32 typedef std::map<std::string, std::list<std::string> > AttrValidators;
33 /// validators IDs by feature ID
34 std::map<std::string, AttrValidators> myFeatures;
35 /// validators IDs and arguments by feature and attribute IDs
36 std::map<std::string, std::map<std::string, AttrValidators> > myAttrs;
37 /// Stores the registered attributes that leads to the concealment of referenced objects in
38 /// data tree. Map from feature kind to set of attribute IDs.
39 std::map<std::string, std::set<std::string> > myConcealed;
42 /// Registers the instance of the validator by the ID
43 MODEL_EXPORT virtual void registerValidator(const std::string& theID,
44 ModelAPI_Validator* theValidator);
46 /// Assigns validator to the feature
47 MODEL_EXPORT virtual void assignValidator(const std::string& theID,
48 const std::string& theFeatureID);
50 /// Assigns validator to the feature with arguments of the validator
51 MODEL_EXPORT virtual void assignValidator(const std::string& theID,
52 const std::string& theFeatureID,
53 const std::list<std::string>& theArguments);
55 /// Assigns validator to the attribute of the feature
56 MODEL_EXPORT virtual void assignValidator(const std::string& theID,
57 const std::string& theFeatureID,
58 const std::string& theAttrID,
59 const std::list<std::string>& theArguments);
61 /// Provides a validator for the feature, returns NULL if no validator
62 MODEL_EXPORT virtual void validators(const std::string& theFeatureID,
63 std::list<ModelAPI_Validator*>& theResult,
64 std::list<std::list<std::string> >& theArguments) const;
65 /// Provides a validator for the attribute, returns NULL if no validator
66 MODEL_EXPORT virtual void validators(const std::string& theFeatureID,
67 const std::string& theAttrID,
68 std::list<ModelAPI_Validator*>& theValidators,
69 std::list<std::list<std::string> >& theArguments) const;
71 /// Returns registered validator by its Id
72 MODEL_EXPORT virtual const ModelAPI_Validator* validator(const std::string& theID) const;
74 /// Returns true if feature and all its attributes are valid.
75 MODEL_EXPORT virtual bool validate(const std::shared_ptr<ModelAPI_Feature>& theFeature) const;
77 /// register that this attribute in feature is not obligatory for the feature execution
78 /// so, it is not needed for the standard validation mechanism
79 virtual void registerNotObligatory(std::string theFeature, std::string theAttribute);
81 /// Returns true if the attribute in feature is not obligatory for the feature execution
82 virtual bool isNotObligatory(std::string theFeature, std::string theAttribute);
84 /// register that this attribute conceals in the object browser
85 /// all referenced features after execution
86 virtual void registerConcealment(std::string theFeature, std::string theAttribute);
88 /// Returns true that it was registered that attribute conceals the referenced result
89 virtual bool isConcealed(std::string theFeature, std::string theAttribute);
92 /// Adds the defualt validators that are usefull for all features.
93 void addDefaultValidators(std::list<ModelAPI_Validator*>& theValidators,
94 std::list<std::list<std::string> >& theArguments) const;
95 /// Get instance from Session
96 Model_ValidatorsFactory();
98 friend class Model_Session;