X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelHighAPI%2FModelHighAPI_Interface.h;h=7c9774e3aa540cbde44096bb82aa02013e24f41d;hb=2054879244f3323c305222c79c57d2db6a487538;hp=f8644968c2b30a10e458d129e66069052490d4a5;hpb=e2e1b927dc9767f699d6d245de62cf43efa5580a;p=modules%2Fshaper.git diff --git a/src/ModelHighAPI/ModelHighAPI_Interface.h b/src/ModelHighAPI/ModelHighAPI_Interface.h index f8644968c..7c9774e3a 100644 --- a/src/ModelHighAPI/ModelHighAPI_Interface.h +++ b/src/ModelHighAPI/ModelHighAPI_Interface.h @@ -1,5 +1,6 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D // Name : ModelHighAPI_Interface.h -// Purpose: +// Purpose: // // History: // 17/05/16 - Sergey POKHODENKO - Creation of the file @@ -11,6 +12,7 @@ #include "ModelHighAPI.h" #include +#include #include #include #include @@ -18,6 +20,7 @@ class ModelAPI_Feature; class ModelAPI_Result; class ModelHighAPI_Selection; +class ModelHighAPI_Dumper; //-------------------------------------------------------------------------------------- /**\class ModelHighAPI_Interface * \ingroup CPPHighAPI @@ -37,18 +40,31 @@ public: MODELHIGHAPI_EXPORT std::shared_ptr feature() const; + /// If feature is composite return intefrace for sub-feature by zero-based index, + /// or empty pointer if feature not composite or does not have sub-feature with such index. + MODELHIGHAPI_EXPORT + std::shared_ptr subFeature(const int theIndex) const; + /// Shortcut for feature()->getKind() MODELHIGHAPI_EXPORT const std::string& getKind() const; /// Shortcut for feature()->execute() + /// \param isForce start execution of feature instead of sending events + MODELHIGHAPI_EXPORT + void execute(bool isForce = false); + + /// Shortcut for feature()->data()->setName() + MODELHIGHAPI_EXPORT + void setName(const std::string& theName); + + /// Return firts object of the feature MODELHIGHAPI_EXPORT - void execute(); + virtual ModelHighAPI_Selection result() const; - // TODO(spo): rename to selectAll() /// Return all objects of the feature MODELHIGHAPI_EXPORT - virtual std::list result() const; + virtual std::list results() const; /// Return default result. Default implementation feature()->lastResult() MODELHIGHAPI_EXPORT @@ -58,10 +74,23 @@ public: 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 myFeature; + std::shared_ptr myFeature; ///< feature of this interface + + std::map myAttrGetter; ///< names of attributes and their getters }; +//! Pointer on Interface object +typedef std::shared_ptr InterfacePtr; + //-------------------------------------------------------------------------------------- //-------------------------------------------------------------------------------------- #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_INTERFACE_H_ */