Dump Python in the High Level Parameterized Geometry API (issue #1648)

[modules/shaper.git] / src / ModelHighAPI / ModelHighAPI_Interface.h

diff --git a/src/ModelHighAPI/ModelHighAPI_Interface.h b/src/ModelHighAPI/ModelHighAPI_Interface.h
index 037b25c5b13ff2ae1777e304201e58bff37399a0..4dd2bca21a0d140e2ddd1e931c1391800986038a 100644 (file)
--- a/src/ModelHighAPI/ModelHighAPI_Interface.h
+++ b/src/ModelHighAPI/ModelHighAPI_Interface.h
@@ -10,10 +10,16 @@
 //--------------------------------------------------------------------------------------
 #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 ModelHighAPI_Interface
  * \ingroup CPPHighAPI
@@ -23,26 +29,58 @@ class ModelHighAPI_Interface
 {
 public:
   /// Constructor
-  MODELHIGHAPI_EXPORT explicit ModelHighAPI_Interface(const std::shared_ptr<ModelAPI_Feature> & theFeature);
+  MODELHIGHAPI_EXPORT
+  explicit ModelHighAPI_Interface(const std::shared_ptr<ModelAPI_Feature> & theFeature);
   /// Destructor
-  MODELHIGHAPI_EXPORT virtual ~ModelHighAPI_Interface();
+  MODELHIGHAPI_EXPORT
+  virtual ~ModelHighAPI_Interface();
 
   /// Return ModelAPI_Feature
-  MODELHIGHAPI_EXPORT std::shared_ptr<ModelAPI_Feature> feature() const;
+  MODELHIGHAPI_EXPORT
+  std::shared_ptr<ModelAPI_Feature> feature() const;
 
   /// Shortcut for feature()->getKind()
-  MODELHIGHAPI_EXPORT const std::string& getKind();
+  MODELHIGHAPI_EXPORT
+  const std::string& getKind() const;
 
   /// Shortcut for feature()->execute()
-  MODELHIGHAPI_EXPORT void execute();
+  MODELHIGHAPI_EXPORT
+  void execute();
+
+  /// Shortcut for feature()->data()->setName()
+  MODELHIGHAPI_EXPORT
+  void setName(const std::string& theName);
+
+  // TODO(spo): rename to selectAll()
+  /// Return all objects of the feature
+  MODELHIGHAPI_EXPORT
+  virtual std::list<ModelHighAPI_Selection> result() const;
+
+  /// Return default result. Default implementation feature()->lastResult()
+  MODELHIGHAPI_EXPORT
+  virtual std::shared_ptr<ModelAPI_Result> defaultResult() const;
 
   /// Throw exception to event loop
-  MODELHIGHAPI_EXPORT void throwException(const std::string & theDescription);
+  MODELHIGHAPI_EXPORT
+  void throwException(const std::string & theDescription);
+
+  /// Return name of getter for specified attribute
+  MODELHIGHAPI_EXPORT
+  const std::string& attributeGetter(const std::string& theAttrName);
+
+  /// Dump wrapped feature
+  MODELHIGHAPI_EXPORT
+  virtual void dump(ModelHighAPI_Dumper& theDumper) const {}
 
 protected:
   std::shared_ptr<ModelAPI_Feature> myFeature;
+
+  std::map<std::string, std::string> myAttrGetter; ///< names of attributes and their getters
 };
 
+//! Pointer on Interface object
+typedef std::shared_ptr<ModelHighAPI_Interface> InterfacePtr;
+
 //--------------------------------------------------------------------------------------
 //--------------------------------------------------------------------------------------
-#endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_INTERFACE_H_ */ 
+#endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_INTERFACE_H_ */