SHAPER  9.12.0
ModelAPI_Filter.h
1 // Copyright (C) 2014-2023 CEA, EDF
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 ModelAPI_Filter_H_
21 #define ModelAPI_Filter_H_
22 
23 #include "ModelAPI_FiltersArgs.h"
24 #include "ModelAPI_ResultBody.h"
25 
26 #include <GeomAPI_Shape.h>
27 
28 
34 {
35 public:
36  virtual ~ModelAPI_Filter() {}
37 
39  virtual const std::string& name() const = 0;
40 
42  virtual bool isSupported(GeomAPI_Shape::ShapeType theType) const = 0;
43 
49  virtual bool isOk(const GeomShapePtr& theShape,
50  const ResultPtr& theResult,
51  const ModelAPI_FiltersArgs& theArgs) const = 0;
52 
54  virtual bool isMultiple() const { return false; }
55 
58  virtual std::string xmlRepresentation() const { return ""; }
59 
62  virtual void initAttributes(ModelAPI_FiltersArgs& /*theArguments*/) {}
63 
66  MODELAPI_EXPORT virtual std::string xmlFromFile(const std::string& theConfigFile) const;
67 
68 private:
69  bool myIsReverse;
70 };
71 
72 typedef std::shared_ptr<ModelAPI_Filter> FilterPtr;
73 
74 #endif
ShapeType
Shape type enum.
Definition: GeomAPI_Shape.h:46
Definition: ModelAPI_Filter.h:34
virtual std::string xmlFromFile(const std::string &theConfigFile) const
Returns XML string which represents GUI of the filter by reading corresponding XML file.
Definition: ModelAPI_Filter.cpp:26
virtual bool isMultiple() const
Returns True if the filter can be used several times within one filtering.
Definition: ModelAPI_Filter.h:54
virtual bool isOk(const GeomShapePtr &theShape, const ResultPtr &theResult, const ModelAPI_FiltersArgs &theArgs) const =0
This method should contain the filter logic.
virtual const std::string & name() const =0
Returns name of the filter to represent it in GUI.
virtual void initAttributes(ModelAPI_FiltersArgs &)
Initializes arguments of a filter.
Definition: ModelAPI_Filter.h:62
virtual std::string xmlRepresentation() const
Returns XML string which represents GUI of the filter By default it returns nothing (no GUI)
Definition: ModelAPI_Filter.h:58
virtual bool isSupported(GeomAPI_Shape::ShapeType theType) const =0
Returns true if the given shape type is supported.
definition of arguments of filters: id of the argument to attributes
Definition: ModelAPI_FiltersArgs.h:31