src/ModelHighAPI/ModelHighAPI_Interface.h

   1 // Name   : ModelHighAPI_Interface.h
   2 // Purpose:
   3 //
   4 // History:
   5 // 17/05/16 - Sergey POKHODENKO - Creation of the file
   6
   7 #ifndef SRC_MODELHIGHAPI_MODELHIGHAPI_INTERFACE_H_
   8 #define SRC_MODELHIGHAPI_MODELHIGHAPI_INTERFACE_H_
   9
  10 //--------------------------------------------------------------------------------------
  11 #include "ModelHighAPI.h"
  12
  13 #include <list>
  14 #include <map>
  15 #include <memory>
  16 #include <string>
  17 #include <iostream>
  18 //--------------------------------------------------------------------------------------
  19 class ModelAPI_Feature;
  20 class ModelAPI_Result;
  21 class ModelHighAPI_Selection;
  22 class ModelHighAPI_Dumper;
  23 //--------------------------------------------------------------------------------------
  24 /**\class ModelHighAPI_Interface
  25  * \ingroup CPPHighAPI
  26  * \brief Base class for feature interfaces
  27  */
  28 class ModelHighAPI_Interface
  29 {
  30 public:
  31   /// Constructor
  32   MODELHIGHAPI_EXPORT
  33   explicit ModelHighAPI_Interface(const std::shared_ptr<ModelAPI_Feature> & theFeature);
  34   /// Destructor
  35   MODELHIGHAPI_EXPORT
  36   virtual ~ModelHighAPI_Interface();
  37
  38   /// Return ModelAPI_Feature
  39   MODELHIGHAPI_EXPORT
  40   std::shared_ptr<ModelAPI_Feature> feature() const;
  41
  42   /// Shortcut for feature()->getKind()
  43   MODELHIGHAPI_EXPORT
  44   const std::string& getKind() const;
  45
  46   /// Shortcut for feature()->execute()
  47   MODELHIGHAPI_EXPORT
  48   void execute();
  49
  50   // TODO(spo): rename to selectAll()
  51   /// Return all objects of the feature
  52   MODELHIGHAPI_EXPORT
  53   virtual std::list<ModelHighAPI_Selection> result() const;
  54
  55   /// Return default result. Default implementation feature()->lastResult()
  56   MODELHIGHAPI_EXPORT
  57   virtual std::shared_ptr<ModelAPI_Result> defaultResult() const;
  58
  59   /// Throw exception to event loop
  60   MODELHIGHAPI_EXPORT
  61   void throwException(const std::string & theDescription);
  62
  63   /// Return name of getter for specified attribute
  64   MODELHIGHAPI_EXPORT
  65   const std::string& attributeGetter(const std::string& theAttrName);
  66
  67   /// Dump wrapped feature
  68   MODELHIGHAPI_EXPORT
  69   virtual void dump(ModelHighAPI_Dumper& theDumper) const {}
  70
  71 protected:
  72   std::shared_ptr<ModelAPI_Feature> myFeature;
  73
  74   std::map<std::string, std::string> myAttrGetter; ///< names of attributes and their getters
  75 };
  76
  77 //! Pointer on Interface object
  78 typedef std::shared_ptr<ModelHighAPI_Interface> InterfacePtr;
  79
  80 //--------------------------------------------------------------------------------------
  81 //--------------------------------------------------------------------------------------
  82 #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_INTERFACE_H_ */