SHAPER  9.15.0
ModelAPI_FiltersFeature.h
1 // Copyright (C) 2014-2025 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_FiltersFeature_H_
21 #define ModelAPI_FiltersFeature_H_
22 
23 #include "ModelAPI_Attribute.h"
24 #include "ModelAPI_Feature.h"
25 
26 
33 {
34 public:
37  virtual std::string addFilter(const std::string theFilterID) = 0;
38 
40  virtual void removeFilter(const std::string theFilterID) = 0;
41 
43  virtual std::list<std::string> filters() const = 0;
44 
46  virtual void setReversed(const std::string theFilterID, const bool theReversed) = 0;
47 
49  virtual bool isReversed(const std::string theFilterID) = 0;
50 
52  virtual std::list<AttributePtr> filterArgs(const std::string theFilterID) const = 0;
53 
56  virtual void setAttribute(const AttributePtr& theAttr) = 0;
57 
59  virtual const AttributePtr& baseAttribute() const = 0;
60 };
61 
62 typedef std::shared_ptr<ModelAPI_FiltersFeature> FiltersFeaturePtr;
63 
64 #endif
Feature function that represents the particular functionality of this operation.
Definition: ModelAPI_Feature.h:41
An interface for working with filters in the feature.
Definition: ModelAPI_FiltersFeature.h:33
virtual void setAttribute(const AttributePtr &theAttr)=0
Sets the attribute (not-persistent field) that contains this filters feature.
virtual const AttributePtr & baseAttribute() const =0
Returns the attribute (not-persistent field) that contains this filters feature.
virtual bool isReversed(const std::string theFilterID)=0
Returns the reversed flag value for the filter.
virtual void setReversed(const std::string theFilterID, const bool theReversed)=0
Stores the reversed flag for the filter.
virtual std::list< std::string > filters() const =0
Returns the list of existing filters in the feature.
virtual std::list< AttributePtr > filterArgs(const std::string theFilterID) const =0
Returns the ordered list of attributes related to the filter.
virtual std::string addFilter(const std::string theFilterID)=0
Adds a filter to the feature.
virtual void removeFilter(const std::string theFilterID)=0
Removes an existing filter from the feature.