Salome HOME
Add copyright header according to request of CEA from 06.06.2017
[modules/shaper.git] / src / GeomValidators / GeomValidators_FeatureKind.h
1 // Copyright (C) 2014-2017  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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #ifndef GeomValidators_FeatureKind_H
22 #define GeomValidators_FeatureKind_H
23
24 #include <GeomValidators.h>
25
26 #include <ModelAPI_AttributeValidator.h>
27 #include <ModelAPI_Attribute.h>
28
29 /**
30  * Generic validator for any attribute of a feature.
31  */
32 class GeomValidators_FeatureKind : public ModelAPI_AttributeValidator
33 {
34 public:
35   /// \return True if the attribute is valid. It checks whether the shape is a
36   /// body subshape. Does not allow select construction shapes.
37   /// \param[in] theAttribute an attribute to check
38   /// \param[in] theArguments a filter parameters
39   /// \param[out] theError error message.
40   GEOMVALIDATORS_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
41                                              const std::list<std::string>& theArguments,
42                                              Events_InfoMessage& theError) const;
43 };
44
45 #endif