X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Validator.h;h=a2c8af67abe69d060c96f75bcb140f12376753e4;hb=ecd0a4691b938201f97329f61ecd001a361c2909;hp=cd73508d58ecb55d3b82e1590bacc6abe6b24a51;hpb=758a57d77b6fa3a0485fa3378a1280c7e87a74aa;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Validator.h b/src/ModelAPI/ModelAPI_Validator.h index cd73508d5..a2c8af67a 100644 --- a/src/ModelAPI/ModelAPI_Validator.h +++ b/src/ModelAPI/ModelAPI_Validator.h @@ -1,15 +1,33 @@ -// File: ModelAPI_Validator.hxx -// Created: 2 Jul 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2017 CEA/DEN, EDF R&D +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or +// email : webmaster.salome@opencascade.com +// #ifndef ModelAPI_Validator_H_ #define ModelAPI_Validator_H_ #include -#include +#include +#include #include class ModelAPI_Feature; +class Events_InfoMessage; /**\class ModelAPI_Validator * \ingroup DataModel @@ -31,11 +49,11 @@ class MODELAPI_EXPORT ModelAPI_Validator } }; -typedef boost::shared_ptr ValidatorPtr; +typedef std::shared_ptr ValidatorPtr; /**\class ModelAPI_ValidatorsFactory * \ingroup DataModel - * \breif Manages the registered validators + * \brief Manages the registered validators * * Allows to get a validator by the feature identifier and * the attribute identifier (if attribute is validated). @@ -64,25 +82,32 @@ class MODELAPI_EXPORT ModelAPI_ValidatorsFactory const std::string& theAttrID, const std::list& theArguments) = 0; + /// Validators is a list of pairs + typedef std::list > > Validators; /// Provides a validator for the feature, returns NULL if no validator virtual void validators(const std::string& theFeatureID, - std::list& theResult, - std::list >& theArguments) const = 0; + Validators& theResult) const = 0; /// Provides a validator for the attribute, returns NULL if no validator virtual void validators(const std::string& theFeatureID, const std::string& theAttrID, - std::list& theValidators, - std::list >& theArguments) const = 0; + Validators& theResult) const = 0; /// Returns registered validator by its Id virtual const ModelAPI_Validator* validator(const std::string& theID) const = 0; /// Returns true if feature and all its attributes are valid. - virtual bool validate(const boost::shared_ptr& theFeature) const = 0; + virtual bool validate(const std::shared_ptr& theFeature) const = 0; + + /// Returns true if the attribute is valid. + virtual bool validate(const std::shared_ptr& theAttribute, + std::string& theValidator, Events_InfoMessage& theError) const = 0; /// register that this attribute in feature is not obligatory for the feature execution /// so, it is not needed for the standard validation mechanism virtual void registerNotObligatory(std::string theFeature, std::string theAttribute) = 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; + /// register that this attribute conceals in the object browser /// all referenced features after execution virtual void registerConcealment(std::string theFeature, std::string theAttribute) = 0; @@ -90,6 +115,19 @@ class MODELAPI_EXPORT ModelAPI_ValidatorsFactory /// Returns true that it was registered that attribute conceals the referenced result virtual bool isConcealed(std::string theFeature, std::string theAttribute) = 0; + /// Register the attribute as a main argument of the feature + virtual void registerMainArgument(std::string theFeature, std::string theAttribute) = 0; + + /// Returns true is the attribute is a main argument of the feature + virtual bool isMainArgument(std::string theFeature, std::string theAttribute) = 0; + + /// Register the case-attribute: this attribute is checked only if its case is selected + virtual void registerCase(std::string theFeature, std::string theAttribute, + const std::list >& theCases) = 0; + + /// Returns true if the attribute must be checked (the case is selected) + virtual bool isCase(FeaturePtr theFeature, std::string theAttribute) = 0; + protected: /// Get instance from Session ModelAPI_ValidatorsFactory()