1 // Name : ModelHighAPI_Interface.h
5 // 17/05/16 - Sergey POKHODENKO - Creation of the file
7 #ifndef SRC_MODELHIGHAPI_MODELHIGHAPI_INTERFACE_H_
8 #define SRC_MODELHIGHAPI_MODELHIGHAPI_INTERFACE_H_
10 //--------------------------------------------------------------------------------------
11 #include "ModelHighAPI.h"
18 //--------------------------------------------------------------------------------------
19 class ModelAPI_Feature;
20 class ModelAPI_Result;
21 class ModelHighAPI_Selection;
22 class ModelHighAPI_Dumper;
23 //--------------------------------------------------------------------------------------
24 /**\class ModelHighAPI_Interface
26 * \brief Base class for feature interfaces
28 class ModelHighAPI_Interface
33 explicit ModelHighAPI_Interface(const std::shared_ptr<ModelAPI_Feature> & theFeature);
36 virtual ~ModelHighAPI_Interface();
38 /// Return ModelAPI_Feature
40 std::shared_ptr<ModelAPI_Feature> feature() const;
42 /// Shortcut for feature()->getKind()
44 const std::string& getKind() const;
46 /// Shortcut for feature()->execute()
50 // TODO(spo): rename to selectAll()
51 /// Return all objects of the feature
53 virtual std::list<ModelHighAPI_Selection> result() const;
55 /// Return default result. Default implementation feature()->lastResult()
57 virtual std::shared_ptr<ModelAPI_Result> defaultResult() const;
59 /// Throw exception to event loop
61 void throwException(const std::string & theDescription);
63 /// Return name of getter for specified attribute
65 const std::string& attributeGetter(const std::string& theAttrName);
67 /// Dump wrapped feature
69 virtual void dump(ModelHighAPI_Dumper& theDumper) const {}
72 std::shared_ptr<ModelAPI_Feature> myFeature;
74 std::map<std::string, std::string> myAttrGetter; ///< names of attributes and their getters
77 //! Pointer on Interface object
78 typedef std::shared_ptr<ModelHighAPI_Interface> InterfacePtr;
80 //--------------------------------------------------------------------------------------
81 //--------------------------------------------------------------------------------------
82 #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_INTERFACE_H_ */