ModelAPI_AttributeSelectionList.h

// Copyright (C) 2014-2026  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef ModelAPI_AttributeSelectionList_H_
#define ModelAPI_AttributeSelectionList_H_
 
#include "ModelAPI_AttributeSelection.h"
#include <ModelAPI_Result.h>
#include <ModelAPI_Filter.h>
 
class GeomAPI_Pnt;
class GeomAPI_Shape;
 
class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute
{
  bool myIsWholeResultAllowed;
  bool myMakeCopy;
public:
  virtual void append(const ObjectPtr& theContext,
                      const std::shared_ptr<GeomAPI_Shape>& theSubShape,
                      const bool theTemporarily = false) = 0;
 
  virtual void append(const std::wstring& theNamingName, const std::string& theType = "") = 0;
 
  virtual void append(const std::shared_ptr<GeomAPI_Pnt>& thePoint,
                      const std::string& theType,
                      const bool theIsIgnoreGroups = false) = 0;
 
  virtual void append(const std::string& theType, const std::wstring& theContextName,
                      const int theIndex) = 0;
 
  virtual void copyTo(std::shared_ptr<ModelAPI_AttributeSelectionList> theTarget) const = 0;
 
  virtual void removeTemporaryValues() = 0;
 
  virtual void removeLast() = 0;
 
  virtual void remove(const std::set<int>& theIndices) = 0;
 
  virtual int size() = 0;
 
  virtual bool isInList(
    const ObjectPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
    const bool theTemporarily = false) = 0;
 
  virtual const std::string selectionType() const = 0;
 
  virtual void setSelectionType(const std::string& theType) = 0;
 
  virtual std::shared_ptr<ModelAPI_AttributeSelection> value(const int theIndex) = 0;
 
  virtual void clear() = 0;
 
  virtual void cashValues(const bool theEnabled) = 0;
 
  virtual void setGeometricalSelection(const bool theIsGeometricalSelection) = 0;
 
  virtual bool isGeometricalSelection() const = 0;
 
  static std::string typeId()
  {
    return "SelectionList";
  }
 
  MODELAPI_EXPORT virtual std::string attributeType();
 
  MODELAPI_EXPORT virtual ~ModelAPI_AttributeSelectionList();
 
  MODELAPI_EXPORT virtual FiltersFeaturePtr filters() const = 0;
 
  MODELAPI_EXPORT virtual void setFilters(FiltersFeaturePtr theFeature) = 0;
 
  MODELAPI_EXPORT virtual void applyFilters() = 0;
 
  MODELAPI_EXPORT virtual void removeFilters() = 0;
 
  MODELAPI_EXPORT virtual const bool isWholeResultAllowed() const {
    return myIsWholeResultAllowed;
  }
 
  MODELAPI_EXPORT virtual void setWholeResultAllowed(const bool theFlag)  {
    myIsWholeResultAllowed = theFlag;
  }
 
  MODELAPI_EXPORT virtual const bool isMakeCopy() const {
    return myMakeCopy;
  }
 
  MODELAPI_EXPORT virtual void setMakeCopy(const bool theFlag)  {
    myMakeCopy = theFlag;
  }
 
protected:
  MODELAPI_EXPORT ModelAPI_AttributeSelectionList() : ModelAPI_Attribute()
  {myIsWholeResultAllowed = false; myMakeCopy = false;}
 
};
 
typedef std::shared_ptr<ModelAPI_AttributeSelectionList> AttributeSelectionListPtr;
 
#endif