X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSketchPlugin%2FSketchPlugin_Validators.h;h=bfaffbeda13bbf6c246793c5e4524d5bb0bcefe1;hb=7a94b78e6086557361f027435686e8420627d459;hp=f201e1b3a0da5248a9a1099910e8be0b39e7f3c6;hpb=586e0f3d89e48652e2ec3587f5e5584e13109b4a;p=modules%2Fshaper.git diff --git a/src/SketchPlugin/SketchPlugin_Validators.h b/src/SketchPlugin/SketchPlugin_Validators.h index f201e1b3a..bfaffbeda 100644 --- a/src/SketchPlugin/SketchPlugin_Validators.h +++ b/src/SketchPlugin/SketchPlugin_Validators.h @@ -1,8 +1,22 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D --> - -// File: SketchPlugin_Validators.h -// Created: 01 Aug 2014 -// Author: Vitaly SMETANNIKOV +// 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 SketchPlugin_Validators_H #define SketchPlugin_Validators_H @@ -26,7 +40,7 @@ class SketchPlugin_DistanceAttrValidator : public ModelAPI_AttributeValidator //! \param theError error message virtual bool isValid(const AttributePtr& theAttribute, const std::list& theArguments, - std::string& theError) const; + Events_InfoMessage& theError) const; }; /**\class SketchPlugin_TangentAttrValidator @@ -44,7 +58,7 @@ class SketchPlugin_TangentAttrValidator : public ModelAPI_AttributeValidator //! \param theError error message virtual bool isValid(const AttributePtr& theAttribute, const std::list& theArguments, - std::string& theError) const; + Events_InfoMessage& theError) const; }; @@ -63,7 +77,7 @@ class SketchPlugin_NotFixedValidator : public ModelAPI_AttributeValidator //! \param theError error message virtual bool isValid(const AttributePtr& theAttribute, const std::list& theArguments, - std::string& theError) const; + Events_InfoMessage& theError) const; }; /**\class SketchPlugin_EqualAttrValidator @@ -81,7 +95,7 @@ class SketchPlugin_EqualAttrValidator : public ModelAPI_AttributeValidator //! \param theError error message virtual bool isValid(const AttributePtr& theAttribute, const std::list& theArguments, - std::string& theError) const; + Events_InfoMessage& theError) const; }; /**\class SketchPlugin_MirrorAttrValidator @@ -99,7 +113,7 @@ class SketchPlugin_MirrorAttrValidator : public ModelAPI_AttributeValidator //! \param theError error message virtual bool isValid(const AttributePtr& theAttribute, const std::list& theArguments, - std::string& theError) const; + Events_InfoMessage& theError) const; }; @@ -118,7 +132,7 @@ class SketchPlugin_CoincidenceAttrValidator : public ModelAPI_AttributeValidator //! \param theError error message virtual bool isValid(const AttributePtr& theAttribute, const std::list& theArguments, - std::string& theError) const; + Events_InfoMessage& theError) const; }; @@ -138,7 +152,7 @@ class SketchPlugin_CopyValidator : public ModelAPI_AttributeValidator //! \param theError error message virtual bool isValid(const AttributePtr& theAttribute, const std::list& theArguments, - std::string& theError) const; + Events_InfoMessage& theError) const; }; /**\class SketchPlugin_SolverErrorValidator @@ -156,7 +170,7 @@ class SketchPlugin_SolverErrorValidator : public ModelAPI_FeatureValidator //! \param theError error message virtual bool isValid(const std::shared_ptr& theFeature, const std::list& theArguments, - std::string& theError) const; + Events_InfoMessage& theError) const; /// Returns true if the attribute in feature is not obligatory for the feature execution virtual bool isNotObligatory(std::string theFeature, std::string theAttribute); @@ -177,7 +191,7 @@ public: //! \param theError error message virtual bool isValid(const AttributePtr& theAttribute, const std::list& theArguments, - std::string& theError) const; + Events_InfoMessage& theError) const; }; @@ -196,7 +210,7 @@ class SketchPlugin_MiddlePointAttrValidator : public ModelAPI_AttributeValidator //! \param theError error message virtual bool isValid(const AttributePtr& theAttribute, const std::list& theArguments, - std::string& theError) const; + Events_InfoMessage& theError) const; }; @@ -215,7 +229,49 @@ class SketchPlugin_ArcTangentPointValidator : public ModelAPI_AttributeValidator //! \param theError error message virtual bool isValid(const AttributePtr& theAttribute, const std::list& theArguments, - std::string& theError) const; + Events_InfoMessage& theError) const; +}; + +/**\class SketchPlugin_SplitValidator + * \ingroup Validators + * \brief Validator for the entity of the following type: + * - Linear segment with point(s) coinident to this line + * - Arc with point(s) coincident to the arc + * - Circle with at least 2 split-points on this circle + * + * Checks that there are coincident point on selected feature. + */ +class SketchPlugin_SplitValidator : public ModelAPI_AttributeValidator +{ + public: + //! returns true if attribute is valid + //! \param theAttribute the checked attribute + //! \param theArguments arguments of the attribute + //! \param theError error message + virtual bool isValid(const AttributePtr& theAttribute, + const std::list& theArguments, + Events_InfoMessage& theError) const; +}; + +/**\class SketchPlugin_TrimValidator + * \ingroup Validators + * \brief Validator for the entity of the following type: + * - Linear segment with point(s) coinident to this line or intersected it + * - Arc with point(s) coincident to the arc or intersected it + * - Circle with at least 2 split-points on this circle or intersected it + * + * Checks that there are coincident point on selected feature. + */ +class SketchPlugin_TrimValidator : public ModelAPI_AttributeValidator +{ + public: + //! returns true if attribute is valid + //! \param theAttribute the checked attribute + //! \param theArguments arguments of the attribute + //! \param theError error message + virtual bool isValid(const AttributePtr& theAttribute, + const std::list& theArguments, + Events_InfoMessage& theError) const; }; /**\class SketchPlugin_IntersectionValidator @@ -231,7 +287,7 @@ class SketchPlugin_IntersectionValidator : public ModelAPI_AttributeValidator //! \param theError error message virtual bool isValid(const AttributePtr& theAttribute, const std::list& theArguments, - std::string& theError) const; + Events_InfoMessage& theError) const; }; /**\class SketchPlugin_ProjectionValidator @@ -247,7 +303,196 @@ class SketchPlugin_ProjectionValidator : public ModelAPI_AttributeValidator //! \param theError error message virtual bool isValid(const AttributePtr& theAttribute, const std::list& theArguments, - std::string& theError) const; + Events_InfoMessage& theError) const; +}; + +/**\class SketchPlugin_DifferentReferenceValidator + * \ingroup Validators + * \brief Validator for attributes of a sketch feature. + * + * It checks that at least one of specified attributes + * refers to another feature in respect to each other. + */ +class SketchPlugin_DifferentReferenceValidator : public ModelAPI_AttributeValidator +{ + public: + //! returns true if attribute is valid + //! \param theAttribute the checked attribute + //! \param theArguments arguments of the attribute + //! \param theError error message + virtual bool isValid(const AttributePtr& theAttribute, + const std::list& theArguments, + Events_InfoMessage& theError) const; +}; + +/**\class SketchPlugin_DifferentPointReferenceValidator + * \ingroup Validators + * \brief Validator for attributes of a sketch feature. + * + * It checks that at least two of specified attributes refer to different points. + */ +class SketchPlugin_DifferentPointReferenceValidator : public ModelAPI_AttributeValidator +{ + public: + //! returns true if attribute is valid + //! \param theAttribute the checked attribute + //! \param theArguments arguments of the attribute + //! \param theError error message + virtual bool isValid(const AttributePtr& theAttribute, + const std::list& theArguments, + Events_InfoMessage& theError) const; +}; + +/**\class SketchPlugin_CirclePassedPointValidator + * \ingroup Validators + * \brief Validator for passed point of MacroCircle feature. + * + * Checks that passed point does not refer to the feature, the center is coincident to. + */ +class SketchPlugin_CirclePassedPointValidator : public ModelAPI_AttributeValidator +{ + public: + //! returns true if attribute is valid + //! \param theAttribute the checked attribute + //! \param theArguments arguments of the attribute + //! \param theError error message + virtual bool isValid(const AttributePtr& theAttribute, + const std::list&, + Events_InfoMessage& theError) const; +}; + +/**\class SketchPlugin_ThirdPointValidator + * \ingroup Validators + * \brief Validator for the third point of MacroCircle feature. + * + * Checks that third point does not lie on a line passed through the first two points. + * Checks that third point does not refer to feature lying between the first two points. + */ +class SketchPlugin_ThirdPointValidator : public ModelAPI_AttributeValidator +{ + public: + //! returns true if attribute is valid + //! \param theAttribute the checked attribute + //! \param theArguments arguments of the attribute + //! \param theError error message + virtual bool isValid(const AttributePtr& theAttribute, + const std::list& theArguments, + Events_InfoMessage& theError) const; + +private: + //! returns true if three points have not been placed on the same line + bool arePointsNotOnLine(const FeaturePtr& theMacroFeature, + Events_InfoMessage& theError) const; + + //! returns true if the first two points have not been separated + //! by a feature referred by thrid point + bool arePointsNotSeparated(const FeaturePtr& theMacroFeature, + const std::list& theArguments, + Events_InfoMessage& theError) const; +}; + +/**\class SketchPlugin_ArcEndPointValidator + * \ingroup Validators + * \brief Validator for the end point of MacroArc feature. + * + * Checks that third point does not lie on a point. + */ +class SketchPlugin_ArcEndPointValidator: public ModelAPI_AttributeValidator +{ + public: + //! returns true if attribute is valid + //! \param theAttribute the checked attribute + //! \param theArguments arguments of the attribute + //! \param theError error message + virtual bool isValid(const AttributePtr& theAttribute, + const std::list& theArguments, + Events_InfoMessage& theError) const; +}; + +/**\class SketchPlugin_ArcEndPointIntersectionValidator + * \ingroup Validators + * \brief Validator for the end point of MacroArc feature. + * + * Checks that third point does lie on edge which intersects arc. + */ +class SketchPlugin_ArcEndPointIntersectionValidator: public ModelAPI_AttributeValidator +{ + public: + //! returns true if attribute is valid + //! \param theAttribute the checked attribute + //! \param theArguments arguments of the attribute + //! \param theError error message + virtual bool isValid(const AttributePtr& theAttribute, + const std::list& theArguments, + Events_InfoMessage& theError) const; +}; + +/**\class SketchPlugin_HasNoConstraint + * \ingroup Validators + * \brief Validator for checking whether the feature has constraint. + * + * Checks that feature of the attribute does not have constraint with some kinds. + * The kinds of constraints should be described in parameters of the validator + * Validator processes the ModelAPI_AttributeRefAttr attribute kind + */ +class SketchPlugin_HasNoConstraint: public ModelAPI_AttributeValidator +{ + public: + //! returns true if attribute is valid + //! \param theAttribute the checked attribute + //! \param theArguments arguments of the attribute + //! \param theError error message + virtual bool isValid(const AttributePtr& theAttribute, + const std::list& theArguments, + Events_InfoMessage& theError) const; +}; + +/**\class SketchPlugin_ReplicationReferenceValidator + * \ingroup Validators + * \brief Validator checking that the replications features (Mirror, + * Multi-Rotation, Mutli-Translation) do not refer to the shapes they produce. + */ +class SketchPlugin_ReplicationReferenceValidator: public ModelAPI_AttributeValidator +{ + public: + //! returns true if attribute is valid + //! \param theAttribute the checked attribute + //! \param theArguments arguments of the attribute + //! \param theError error message + virtual bool isValid(const AttributePtr& theAttribute, + const std::list& theArguments, + Events_InfoMessage& theError) const; +}; + +/**\class SketchPlugin_SketchFeatureValidator + * \ingroup Validators + * \brief Validator for checking whether the feature referred by attribute is a sketch feature. + */ +class SketchPlugin_SketchFeatureValidator: public ModelAPI_AttributeValidator +{ + public: + //! returns true if attribute is valid + //! \param theAttribute the checked attribute + //! \param theArguments arguments of the attribute + //! \param theError error message + virtual bool isValid(const AttributePtr& theAttribute, + const std::list& theArguments, + Events_InfoMessage& theError) const; +}; + +/**\class SketchPlugin_MultiRotationAngleValidator + * \ingroup Validators + * \brief Validator for checking whether the angle of MultiRotation is in range [0, 360]. + */ +class SketchPlugin_MultiRotationAngleValidator : public ModelAPI_AttributeValidator +{ + //! returns true if attribute is valid + //! \param theAttribute the checked attribute + //! \param theArguments arguments of the attribute + //! \param theError error message + virtual bool isValid(const AttributePtr& theAttribute, + const std::list& theArguments, + Events_InfoMessage& theError) const; }; #endif