X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_FeatureValidator.h;h=e412301fec5dfbad8cda15b775f6c0f397eb7632;hb=bf4f4d92dd943361f8a86405e9287fffc8af7d56;hp=86f287c99460cf08dfe963efb05b60f8fad6cd69;hpb=3874b57fe5aba25ff5aee2a07654fc23c1ee8eb0;p=modules%2Fshaper.git diff --git a/src/Model/Model_FeatureValidator.h b/src/Model/Model_FeatureValidator.h index 86f287c99..e412301fe 100644 --- a/src/Model/Model_FeatureValidator.h +++ b/src/Model/Model_FeatureValidator.h @@ -15,17 +15,27 @@ #include #include +/**\class Model_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 Model_FeatureValidator : public ModelAPI_FeatureValidator { // not obligatory attributes, not checked for initialization std::map > myNotObligatory; - public: +public: /// Returns true if feature and/or attributes are valid /// \param theFeature the validated feature + /// \param theArguments the arguments in the configuration file for this validator + /// \returns true if feature is valid MODEL_EXPORT virtual bool isValid(const std::shared_ptr& theFeature, const std::list& theArguments) const; - // sets not obligatory attributes, not checked for initialization + /// sets not obligatory attributes, not checked for initialization virtual void registerNotObligatory(std::string theFeature, std::string theAttribute); /// Returns true if the attribute in feature is not obligatory for the feature execution