X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_FeatureValidator.h;h=f051c1e0d4a27e23bf64baea4e3cf12f755a7b19;hb=497397f795254cb5adf0d727f5858d5aeb16eaf3;hp=85e06609c6f3facdd654fee13edd8cf82b406cbd;hpb=3874b57fe5aba25ff5aee2a07654fc23c1ee8eb0;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_FeatureValidator.h b/src/ModelAPI/ModelAPI_FeatureValidator.h index 85e06609c..f051c1e0d 100644 --- a/src/ModelAPI/ModelAPI_FeatureValidator.h +++ b/src/ModelAPI/ModelAPI_FeatureValidator.h @@ -10,15 +10,29 @@ #include "ModelAPI.h" #include "ModelAPI_Validator.h" -class ModelAPI_FeatureValidator : public ModelAPI_Validator +/**\class ModelAPI_FeatureValidator + * \ingroup DataModel + * \brief The geneneric validator for the whole feature. + * + * Can be redefined for some specific feature, but by default for each feature this validator is + * used: it checks each argument of the feature and if one of it is not valid (and obligatory), + * the hole feature is invalid. + */ +class MODELAPI_EXPORT ModelAPI_FeatureValidator : public ModelAPI_Validator { public: + /// Default constructor + ModelAPI_FeatureValidator(); + /// Virtual destructor + virtual ~ModelAPI_FeatureValidator(); + /// 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 + /// \param theError the error string message if validation fails virtual bool isValid(const std::shared_ptr& theFeature, - const std::list& theArguments) const = 0; + const std::list& theArguments, + std::string& theError) const = 0; /// Returns true if the attribute in feature is not obligatory for the feature execution virtual bool isNotObligatory(std::string theFeature, std::string theAttribute) = 0;