ModelAPI_Feature.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 ModelAPI_Feature_H_
#define ModelAPI_Feature_H_
 
#include <ModelAPI.h>
#include <ModelAPI_Object.h>
#include <ModelAPI_Data.h>
#include <ModelAPI_Document.h>
 
#include <memory>
 
#include <list>
#include <string>
 
typedef std::list<std::shared_ptr<GeomAPI_Shape> > ListOfShape;
 
class ModelAPI_Feature : public ModelAPI_Object
{
  std::list<std::shared_ptr<ModelAPI_Result> > myResults;
  bool myIsDisabled;
  bool myIsStable;
 
 public:
  virtual const std::string& getKind() = 0;
 
  inline static std::string group()
  {
    static std::string MY_GROUP = "Features";
    return MY_GROUP;
  }
 
  virtual std::shared_ptr<ModelAPI_Document> document() const
  {
    return ModelAPI_Object::document();
  }
 
  virtual std::string groupName()
  {
    return group();
  }
 
  virtual void execute() = 0;
 
  virtual bool compute(const std::string& /*theAttributeId*/) { return false; };
 
  MODELAPI_EXPORT virtual void setError(const std::string& theError,
                                        bool isSend = true,
                                        bool isTranslate = true);
 
  virtual std::string error() const {
    return data()->error();
  }
 
  MODELAPI_EXPORT const std::list<std::shared_ptr<ModelAPI_Result> >& results();
  MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> firstResult() const;
  MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> lastResult();
  MODELAPI_EXPORT void setResult(const std::shared_ptr<ModelAPI_Result>& theResult);
  MODELAPI_EXPORT void setResult(const std::shared_ptr<ModelAPI_Result>& theResult,
                                 const int theIndex);
  MODELAPI_EXPORT void removeResults(const int theSinceIndex,
    const bool theForever = true, const bool theFlush = true);
  MODELAPI_EXPORT void eraseResults(const bool theForever = true);
  MODELAPI_EXPORT virtual void erase();
  MODELAPI_EXPORT void eraseResultFromList(const std::shared_ptr<ModelAPI_Result>& theResult);
 
  virtual bool isPersistentResult() {return true;}
 
  virtual bool isAction()
  {
    return false;
  }
 
  MODELAPI_EXPORT virtual bool isMacro() const;
 
  MODELAPI_EXPORT virtual bool isPreviewNeeded() const;
 
  MODELAPI_EXPORT virtual const std::string& documentToAdd();
 
  MODELAPI_EXPORT virtual bool setDisabled(const bool theFlag);
 
  MODELAPI_EXPORT virtual bool isDisabled();
 
  MODELAPI_EXPORT virtual ~ModelAPI_Feature();
 
  MODELAPI_EXPORT static std::shared_ptr<ModelAPI_Feature> feature(ObjectPtr theObject);
 
  MODELAPI_EXPORT virtual bool setStable(const bool theFlag);
 
  MODELAPI_EXPORT virtual bool isStable();
 
  MODELAPI_EXPORT virtual bool isEditable();
 
  MODELAPI_EXPORT virtual bool customAction(const std::string& theActionId);
 
  MODELAPI_EXPORT virtual ListOfShape
                  vertices(const bool theOnlyUnique = false);
 
  MODELAPI_EXPORT virtual ListOfShape
                  edges(const bool theOnlyUnique = false);
 
  MODELAPI_EXPORT virtual ListOfShape
                  wires(const bool theOnlyUnique = false);
 
  MODELAPI_EXPORT virtual ListOfShape
                  faces(const bool theOnlyUnique = false);
 
  MODELAPI_EXPORT virtual ListOfShape
                  shells(const bool theOnlyUnique = false);
 
  MODELAPI_EXPORT virtual ListOfShape
                  solids(const bool theOnlyUnique = false);
 
 //
 // Helper methods, aliases for data()->method()
 // -----------------------------------------------------------------------------------------------
  inline std::wstring name()
  {
    return data()->name();
  }
  inline std::shared_ptr<ModelAPI_AttributeBoolean> boolean(const std::string& theID)
  {
    return data()->boolean(theID);
  }
  inline std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID)
  {
    return data()->document(theID);
  }
  inline std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID)
  {
    return data()->real(theID);
  }
  inline std::shared_ptr<ModelAPI_AttributeInteger> integer(const std::string& theID)
  {
    return data()->integer(theID);
  }
  inline std::shared_ptr<ModelAPI_AttributeIntArray> intArray(const std::string& theID)
  {
    return data()->intArray(theID);
  }
  inline std::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string& theID)
  {
    return data()->refattr(theID);
  }
  inline std::shared_ptr<ModelAPI_AttributeRefAttrList> refattrlist(const std::string& theID)
  {
    return data()->refattrlist(theID);
  }
  inline std::shared_ptr<ModelAPI_AttributeReference> reference(const std::string& theID)
  {
    return data()->reference(theID);
  }
  inline std::shared_ptr<ModelAPI_AttributeRefList> reflist(const std::string& theID)
  {
    return data()->reflist(theID);
  }
  inline std::shared_ptr<ModelAPI_AttributeSelection> selection(const std::string& theID)
  {
    return data()->selection(theID);
  }
  inline std::shared_ptr<ModelAPI_AttributeSelectionList> selectionList(const std::string& theID)
  {
    return data()->selectionList(theID);
  }
  inline std::shared_ptr<ModelAPI_AttributeString> string(const std::string& theID)
  {
    return data()->string(theID);
  }
  inline std::shared_ptr<ModelAPI_AttributeStringArray> stringArray(const std::string& theID)
  {
    return data()->stringArray(theID);
  }
  inline std::shared_ptr<ModelAPI_AttributeTables> tables(const std::string& theID)
  {
    return data()->tables(theID);
  }
  inline std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID)
  {
    return data()->attribute(theID);
  }
 
 private:
  void showErrorMessage();
 
 protected:
  MODELAPI_EXPORT virtual void init();
 
  friend class Model_Document;
  friend class Model_Objects;
};
 
typedef std::shared_ptr<ModelAPI_Feature> FeaturePtr;
 
class ModelAPI_FeatureCopyInterface {
public:
  virtual ~ModelAPI_FeatureCopyInterface() {}
 
  virtual void getCopies(ObjectPtr theContext, std::shared_ptr<GeomAPI_Shape> theValue,
                         std::list<ObjectPtr>& theCopyContext,
                         std::list<std::shared_ptr<GeomAPI_Shape> >& theCopyVals) = 0;
};
 
#endif