X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_FeatureValidator.h;h=f051c1e0d4a27e23bf64baea4e3cf12f755a7b19;hb=506a83727ca8f8297fc1dcdf4ea40d7865c35450;hp=3dafdf813bd47fabf465166060727511c27581b1;hpb=cb7a02e2d7e5f4c675571888b8119a8c58069a0d;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_FeatureValidator.h b/src/ModelAPI/ModelAPI_FeatureValidator.h index 3dafdf813..f051c1e0d 100644 --- a/src/ModelAPI/ModelAPI_FeatureValidator.h +++ b/src/ModelAPI/ModelAPI_FeatureValidator.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: ModelAPI_FeatureValidator.h // Created: 8 Jul 2014 // Author: Vitaly SMETANNIKOV @@ -8,15 +10,32 @@ #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 - virtual bool isValid(const boost::shared_ptr& theFeature, - const std::list& theArguments) const = 0; + /// \param theError the error string message if validation fails + virtual bool isValid(const std::shared_ptr& theFeature, + 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; }; #endif