1 // File: ModelAPI_Validator.hxx
3 // Author: Mikhail PONIKAROV
5 #ifndef ModelAPI_Validator_H_
6 #define ModelAPI_Validator_H_
9 #include <boost/shared_ptr.hpp>
12 class ModelAPI_Feature;
14 /**\class ModelAPI_Validator
16 * \brief Allows to validate the attribute value of a feature or the whole feature.
18 * This object is assigned by the name
19 * in the XML file to the specific attribute or to the whole feature.
20 * If validator returns "false", it is signalized in user interface
21 * and feature is not executed.
22 * Validators must be registered in the validators factory to be
23 * correctly identified by the XML string-ID.
25 class MODELAPI_EXPORT ModelAPI_Validator
28 // Make virtual destructor in order to make the class polymorphic
29 virtual ~ModelAPI_Validator()
33 /// Returns true if feature and/or attributes are valid
34 /// \param theFeature the validated feature
35 /// \param theAttr the validated attribute ID, empty string of feature is validated
36 /// \param theArguments list of string, feature attribute names: dependent attributes
37 //virtual bool validate(const boost::shared_ptr<ModelAPI_Feature>& theFeature,
38 // const std::string theAttr, std::list<std::string> theArguments) const = 0;
41 typedef boost::shared_ptr<ModelAPI_Validator> ValidatorPtr;
43 /**\class ModelAPI_ValidatorsFactory
45 * \breif Manages the registered validators
47 * Allows to get a validator by the feature identifier and
48 * the attribute identifier (if attribute is validated).
49 * All accessible validators mustbe registered by the ID string first.
50 * The instance of this factory can be get in the PluginManager.
51 * Keeps the validator objects alive and just returns one of it by request.
52 * All the needed information is provided to the validator as an argument,
53 * this allows to work with them independently from the feature specific object.
55 class MODELAPI_EXPORT ModelAPI_ValidatorsFactory
58 /// Registers the instance of the validator by the ID
59 virtual void registerValidator(const std::string& theID, ModelAPI_Validator* theValidator) = 0;
61 /// Assigns validator to the feature
62 virtual void assignValidator(const std::string& theID, const std::string& theFeatureID) = 0;
64 /// Assigns validator to the feature with arguments of the validator
65 virtual void assignValidator(const std::string& theID,
66 const std::string& theFeatureID,
67 const std::list<std::string>& theArguments) = 0;
69 /// Assigns validator to the attribute of the feature
70 virtual void assignValidator(const std::string& theID, const std::string& theFeatureID,
71 const std::string& theAttrID,
72 const std::list<std::string>& theArguments) = 0;
74 /// Provides a validator for the feature, returns NULL if no validator
75 virtual void validators(const std::string& theFeatureID,
76 std::list<ModelAPI_Validator*>& theResult,
77 std::list<std::list<std::string> >& theArguments) const = 0;
78 /// Provides a validator for the attribute, returns NULL if no validator
79 virtual void validators(const std::string& theFeatureID, const std::string& theAttrID,
80 std::list<ModelAPI_Validator*>& theValidators,
81 std::list<std::list<std::string> >& theArguments) const = 0;
83 /// Returns registered validator by its Id
84 virtual const ModelAPI_Validator* validator(const std::string& theID) const = 0;
86 /// Returns true if feature and all its attributes are valid.
87 virtual bool validate(const boost::shared_ptr<ModelAPI_Feature>& theFeature) const = 0;
90 /// Get instance from PluginManager
91 ModelAPI_ValidatorsFactory()