src/CollectionPlugin/CollectionPlugin_Validators.h

   1 // Copyright (C) 2014-2022  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef CollectionPlugin_Validators_H
  21 #define CollectionPlugin_Validators_H
  22
  23 #include "CollectionPlugin.h"
  24 #include <ModelAPI_AttributeValidator.h>
  25 #include <ModelAPI_FeatureValidator.h>
  26
  27 /**\class CollectionPlugin_FieldValidator
  28  * \ingroup Validators
  29  * \brief Validator for the field.
  30  */
  31 class CollectionPlugin_FieldValidator : public ModelAPI_FeatureValidator
  32 {
  33 public:
  34   //! returns true if there are no solver errors
  35   //! \param theFeature the checked feature
  36   //! \param theArguments arguments of the feature (not used)
  37   //! \param theError error message
  38   virtual bool isValid(const FeaturePtr& theFeature,
  39     const std::list<std::string>& theArguments,
  40     Events_InfoMessage& theError) const;
  41 };
  42
  43 /**\class CollectionPlugin_GroupOperationAttributeValidator
  44  * \ingroup Validators
  45  * \brief Validator for the parameters of operation on groups.
  46  */
  47 class CollectionPlugin_GroupOperationAttributeValidator : public ModelAPI_AttributeValidator
  48 {
  49   //! Returns true if attribute is ok.
  50   //! \param[in] theAttribute the checked attribute.
  51   //! \param[in] theArguments arguments of the attribute.
  52   //! \param[out] theError error message.
  53   virtual bool isValid(const AttributePtr& theAttribute,
  54                        const std::list<std::string>& theArguments,
  55                        Events_InfoMessage& theError) const;
  56 };
  57
  58 /**\class CollectionPlugin_GroupSelectionValidator
  59 * \ingroup Validators
  60 * \brief Validator for prevent adding whole group in other group.
  61 */
  62 class CollectionPlugin_GroupSelectionValidator : public ModelAPI_AttributeValidator
  63 {
  64   //! Returns true if attribute is ok.
  65   //! \param[in] theAttribute the checked attribute.
  66   //! \param[in] theArguments arguments of the attribute (not used).
  67   //! \param[out] theError error message.
  68   virtual bool isValid(const AttributePtr& theAttribute,
  69     const std::list<std::string>& theArguments,
  70     Events_InfoMessage& theError) const;
  71 };
  72
  73 #endif