ModelHighAPI_Interface.h

// Copyright (C) 2014-2025  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 SRC_MODELHIGHAPI_MODELHIGHAPI_INTERFACE_H_
#define SRC_MODELHIGHAPI_MODELHIGHAPI_INTERFACE_H_
 
//--------------------------------------------------------------------------------------
#include "ModelHighAPI.h"
 
#include <list>
#include <map>
#include <memory>
#include <string>
#include <iostream>
//--------------------------------------------------------------------------------------
class ModelAPI_Feature;
class ModelAPI_Result;
class ModelHighAPI_Selection;
class ModelHighAPI_Dumper;
 
class GeomAPI_Shape;
 
typedef std::list<std::shared_ptr<GeomAPI_Shape> > ListOfShape;
//--------------------------------------------------------------------------------------
class ModelHighAPI_Interface
{
public:
  MODELHIGHAPI_EXPORT
  explicit ModelHighAPI_Interface(const std::shared_ptr<ModelAPI_Feature> & theFeature);
  MODELHIGHAPI_EXPORT
  virtual ~ModelHighAPI_Interface();
 
  MODELHIGHAPI_EXPORT
  std::shared_ptr<ModelAPI_Feature> feature() const;
 
  MODELHIGHAPI_EXPORT
  std::shared_ptr<ModelHighAPI_Interface> subFeature(const int theIndex) const;
 
  MODELHIGHAPI_EXPORT
  const std::string& getKind() const;
 
  MODELHIGHAPI_EXPORT
  void execute(bool isForce = false);
 
  MODELHIGHAPI_EXPORT
  void setName(const std::wstring& theName);
 
  MODELHIGHAPI_EXPORT
  std::wstring name() const;
 
  MODELHIGHAPI_EXPORT
  virtual ModelHighAPI_Selection result() const;
 
  MODELHIGHAPI_EXPORT
  virtual std::list<ModelHighAPI_Selection> results() const;
 
  MODELHIGHAPI_EXPORT
  virtual std::shared_ptr<ModelAPI_Result> defaultResult() const;
 
  MODELHIGHAPI_EXPORT
  void throwException(const std::string & theDescription);
 
  MODELHIGHAPI_EXPORT
  const std::string& attributeGetter(const std::string& theAttrName);
 
  MODELHIGHAPI_EXPORT
  virtual void dump(ModelHighAPI_Dumper& /*theDumper*/) const {}
 
  MODELHIGHAPI_EXPORT virtual ListOfShape
               vertices(const bool theOnlyUnique = false);
 
  MODELHIGHAPI_EXPORT virtual ListOfShape 
               edges(const bool theOnlyUnique = false);
 
  MODELHIGHAPI_EXPORT virtual ListOfShape
               wires(const bool theOnlyUnique = false);
 
  MODELHIGHAPI_EXPORT virtual ListOfShape
               faces(const bool theOnlyUnique = false);
 
  MODELHIGHAPI_EXPORT virtual ListOfShape 
               shells(const bool theOnlyUnique = false);
 
  MODELHIGHAPI_EXPORT virtual ListOfShape
               solids(const bool theOnlyUnique = false);
 
protected:
  std::shared_ptr<ModelAPI_Feature> myFeature; 
 
  std::map<std::string, std::string> myAttrGetter; 
};
 
typedef std::shared_ptr<ModelHighAPI_Interface> InterfacePtr;
 
//--------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------
#endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_INTERFACE_H_ */