X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Validator.h;h=c621363d5e147b15fdf43d7382f336605c88face;hb=0cf033e3d2d9a6419aac40d77cd200187562a159;hp=7bc08324a78db0b7ab1616dc0bc696c6e3bd4ed5;hpb=9d39123efbd6bde772377542ce40fb51f7925c1f;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Validator.h b/src/ModelAPI/ModelAPI_Validator.h index 7bc08324a..c621363d5 100644 --- a/src/ModelAPI/ModelAPI_Validator.h +++ b/src/ModelAPI/ModelAPI_Validator.h @@ -1,15 +1,19 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: ModelAPI_Validator.hxx // Created: 2 Jul 2014 // Author: Mikhail PONIKAROV -#ifndef ModelAPI_Validator_HeaderFile -#define ModelAPI_Validator_HeaderFile +#ifndef ModelAPI_Validator_H_ +#define ModelAPI_Validator_H_ #include -#include +#include +#include #include class ModelAPI_Feature; +class Events_InfoMessage; /**\class ModelAPI_Validator * \ingroup DataModel @@ -24,61 +28,104 @@ class ModelAPI_Feature; */ class MODELAPI_EXPORT ModelAPI_Validator { -public: + public: // Make virtual destructor in order to make the class polymorphic - virtual ~ModelAPI_Validator() {}; - - /// 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 validate(const boost::shared_ptr& theFeature, - // const std::string theAttr, std::list theArguments) const = 0; + virtual ~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). * All accessible validators mustbe registered by the ID string first. - * The instance of this factory can be get in the PluginManager. + * The instance of this factory can be get in the Session. * Keeps the validator objects alive and just returns one of it by request. * All the needed information is provided to the validator as an argument, * this allows to work with them independently from the feature specific object. */ class MODELAPI_EXPORT ModelAPI_ValidatorsFactory { -public: + public: /// Registers the instance of the validator by the ID virtual void registerValidator(const std::string& theID, ModelAPI_Validator* theValidator) = 0; /// Assigns validator to the feature virtual void assignValidator(const std::string& theID, const std::string& theFeatureID) = 0; + /// Assigns validator to the feature with arguments of the validator + virtual void assignValidator(const std::string& theID, + const std::string& theFeatureID, + const std::list& theArguments) = 0; + /// Assigns validator to the attribute of the feature - virtual void assignValidator(const std::string& theID, - const std::string& theFeatureID, const std::string& theAttrID, - const std::list& theArguments) = 0; + virtual void assignValidator(const std::string& theID, const std::string& theFeatureID, + 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 const ModelAPI_Validator* validator(const std::string& theFeatureID) const = 0; - + virtual void validators(const std::string& theFeatureID, + Validators& theResult) const = 0; /// Provides a validator for the attribute, returns NULL if no validator - virtual const ModelAPI_Validator* validator( - const std::string& theFeatureID, const std::string& theAttrID) const = 0; + virtual void validators(const std::string& theFeatureID, const std::string& theAttrID, + 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 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; + + /// Returns true that it was registered that attribute conceals the referenced result + virtual bool isConcealed(std::string theFeature, std::string theAttribute) = 0; + + /// Registers (by Recover feature) cancel of concealment of specific result by specific feature. + /// If theCanceledFeat is empty, the concealment is canceled for this result forever. + virtual void registerUnconcealment(std::shared_ptr theUnconcealed, + std::shared_ptr theCanceledFeat) = 0; + + /// Disables cancel of concealment of specific result by specific feature. + virtual void disableUnconcealment(std::shared_ptr theUnconcealed, + std::shared_ptr theCanceledFeat) = 0; + + /// Returns true if concealment is canceled. + virtual bool isUnconcealed(std::shared_ptr theUnconcealed, + std::shared_ptr theCanceledFeat) = 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 the result of "validate" method for attribute of validator. - /// If validator is not exists, returns true: everything is valid by default. - //virtual bool validate( - // const boost::shared_ptr& theFeature, const std::string& theAttrID) const = 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 PluginManager - ModelAPI_ValidatorsFactory() {} + protected: + /// Get instance from Session + ModelAPI_ValidatorsFactory() + { + } }; #endif