src/ModelAPI/ModelAPI_AttributeValidator.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModelAPI_AttributeValidator.h
   4 // Created:     4 Sep 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef ModelAPI_AttributeValidator_H
   8 #define ModelAPI_AttributeValidator_H
   9
  10 #include <ModelAPI.h>
  11 #include <ModelAPI_Attribute.h>
  12 #include <ModelAPI_Validator.h>
  13
  14 /**
  15  * Generic validator for any attribute of a feature.
  16  */
  17 class ModelAPI_AttributeValidator : public ModelAPI_Validator
  18 {
  19 public:
  20   //! \returns true if attribute is valid
  21   //! \param theAttribute the checked attribute
  22   //! \param theArguments arguments of the attribute
  23   //! \param theError the error string message if validation fails
  24   virtual bool isValid(const AttributePtr& theAttribute,
  25                        const std::list<std::string>& theArguments,
  26                        Events_InfoMessage& theError) const = 0;
  27
  28   MODELAPI_EXPORT ~ModelAPI_AttributeValidator();
  29 };
  30
  31 #endif