src/FiltersAPI/FiltersAPI_Argument.h

   1 // Copyright (C) 2014-2021  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_ARGUMENT_H_
  21 #define FILTERSAPI_ARGUMENT_H_
  22
  23 #include "FiltersAPI.h"
  24
  25 #include <ModelAPI_AttributeSelection.h>
  26
  27 #include <ModelHighAPI_Dumper.h>
  28 #include <ModelHighAPI_Selection.h>
  29
  30 /**\class FiltersAPI_Argument
  31  * \ingroup CPPHighAPI
  32  * \brief Argument of the Filter
  33  */
  34 class FiltersAPI_Argument
  35 {
  36 public:
  37   FILTERSAPI_EXPORT FiltersAPI_Argument();
  38
  39   FILTERSAPI_EXPORT
  40   FiltersAPI_Argument(const bool theValue);
  41
  42   FILTERSAPI_EXPORT
  43   FiltersAPI_Argument(const std::string& theValue);
  44
  45   FILTERSAPI_EXPORT
  46   FiltersAPI_Argument(const ModelHighAPI_Selection& theSelection);
  47
  48   FILTERSAPI_EXPORT
  49   FiltersAPI_Argument(const AttributeSelectionPtr& theSelection);
  50
  51   /// Destructor
  52   FILTERSAPI_EXPORT
  53   virtual ~FiltersAPI_Argument();
  54
  55   const bool boolean() const { return myBoolean; }
  56   const std::string& string() const { return myValue; }
  57   const ModelHighAPI_Selection& selection() const { return mySelection; }
  58
  59   /// Dump wrapped feature
  60   FILTERSAPI_EXPORT
  61   void dump(ModelHighAPI_Dumper& theDumper) const;
  62
  63 private:
  64   bool myBoolean;
  65   std::string myValue;
  66   ModelHighAPI_Selection mySelection;
  67   AttributeSelectionPtr mySelectionAttr;
  68 };
  69
  70 #endif