src/FiltersAPI/FiltersAPI_Filter.h

   1 // Copyright (C) 2014-2023  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 FILTERSAPI_FILTER_H_
  21 #define FILTERSAPI_FILTER_H_
  22
  23 #include "FiltersAPI.h"
  24 #include "FiltersAPI_Argument.h"
  25
  26 #include <ModelHighAPI_Dumper.h>
  27 #include <ModelHighAPI_Selection.h>
  28
  29 class ModelAPI_Attribute;
  30
  31 /**\class FiltersAPI_Filter
  32  * \ingroup CPPHighAPI
  33  * \brief Interface for the Filter
  34  */
  35 class FiltersAPI_Filter
  36 {
  37 public:
  38   FILTERSAPI_EXPORT
  39   FiltersAPI_Filter(
  40       const std::string& theName,
  41       const bool theRevertFilter = false,
  42       const std::list<FiltersAPI_Argument>& theArguments = std::list<FiltersAPI_Argument>());
  43
  44   // Internal constructor based on filter arguments
  45   FILTERSAPI_EXPORT
  46   FiltersAPI_Filter(const std::string& theName,
  47                     const std::list<std::shared_ptr<ModelAPI_Attribute> >& theArguments);
  48
  49   /// Destructor
  50   FILTERSAPI_EXPORT
  51   virtual ~FiltersAPI_Filter();
  52
  53   const std::string& name() const { return myName; }
  54   bool isReversed() const { return myReversed; }
  55   const std::list<FiltersAPI_Argument>& arguments() const { return myFilterArguments; }
  56
  57   /// Dump wrapped feature
  58   FILTERSAPI_EXPORT
  59   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  60
  61 private:
  62   std::string myName;
  63   bool myReversed;
  64   std::list<FiltersAPI_Argument> myFilterArguments;
  65 };
  66
  67 typedef std::shared_ptr<FiltersAPI_Filter> FilterAPIPtr;
  68
  69 /// Create list of filters
  70 FILTERSAPI_EXPORT FilterAPIPtr
  71 addFilter(const std::string& name = std::string(),
  72           const bool exclude = false,
  73           const std::list<FiltersAPI_Argument>& args = std::list<FiltersAPI_Argument>());
  74
  75 #endif