X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Feature.h;h=b42266074ba9bb3a2e54e2a015194de812a8539f;hb=7edae2e3ede0ca739810de747c975f4983398f76;hp=dd98c597a02c7f466f9caa61a01ec77d804e5c38;hpb=04e52dd31f27fb0004f97fa8ef4e275d4c1b962b;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Feature.h b/src/ModelAPI/ModelAPI_Feature.h index dd98c597a..b42266074 100644 --- a/src/ModelAPI/ModelAPI_Feature.h +++ b/src/ModelAPI/ModelAPI_Feature.h @@ -5,77 +5,66 @@ #ifndef ModelAPI_Feature_HeaderFile #define ModelAPI_Feature_HeaderFile -#include "ModelAPI.h" +#include "ModelAPI_Object.h" #include "ModelAPI_PluginManager.h" #include +#include #include class ModelAPI_Data; class ModelAPI_Document; +class ModelAPI_Result; /**\class ModelAPI_Feature * \ingroup DataModel - * \brief Functionality of the model object: to update result, - * to initialize attributes, etc. + * \brief Feature function that represents the particular functionality + * of this operation. Produces results by the arguments. */ -class ModelAPI_Feature +class ModelAPI_Feature : public ModelAPI_Object { - boost::shared_ptr myData; ///< manager of the data model of a feature - boost::shared_ptr myDoc; ///< document this feature belongs to - + ///< list of current results of this feature + std::list > myResults; public: - /// Returns the kind of a feature (like "Point") - MODELAPI_EXPORT virtual const std::string& getKind() = 0; + /// Returns the unique kind of a feature (like "Point") + virtual const std::string& getKind() = 0; + + /// Returns the group identifier of all features + static std::string group() + {static std::string MY_GROUP = "Features"; return MY_GROUP;} - /// Returns to which group in the document must be added feature - MODELAPI_EXPORT virtual const std::string& getGroup() = 0; + /// Returns the group identifier of this result + virtual std::string groupName() { return group(); } /// Request for initialization of data model of the feature: adding all attributes - MODELAPI_EXPORT virtual void initAttributes() = 0; + virtual void initAttributes() = 0; - /// Computes or recomputes the result - MODELAPI_EXPORT virtual void execute() = 0; + /// Computes or recomputes the results + virtual void execute() = 0; - /// Returns true if this feature must be displayed in the history (top level of Part tree) - MODELAPI_EXPORT virtual bool isInHistory() {return true;} + /// returns the current results of the feature + MODELAPI_EXPORT const std::list >& results(); + /// returns the first result in the list or NULL reference + MODELAPI_EXPORT boost::shared_ptr firstResult(); + /// sets the alone result + MODELAPI_EXPORT void setResult(const boost::shared_ptr& theResult); + /// sets the result by index (zero based), results before this must be set before + MODELAPI_EXPORT void setResult( + const boost::shared_ptr& theResult, const int theIndex); /// Returns true if this feature must not be created: this is just an action - /// that is not stored in the features history (like delete part). - MODELAPI_EXPORT virtual bool isAction() {return false;} - - /// Returns the data manager of this feature - MODELAPI_EXPORT virtual boost::shared_ptr data() {return myData;} + /// that is not stored in the features history and data model (like "delete part"). + virtual bool isAction() {return false;} /// Must return document where the new feature must be added to /// By default it is current document - MODELAPI_EXPORT virtual boost::shared_ptr documentToAdd() - {return ModelAPI_PluginManager::get()->currentDocument();} - - /// Returns document this feature belongs to - MODELAPI_EXPORT virtual boost::shared_ptr document() - {return myDoc;} + MODELAPI_EXPORT virtual boost::shared_ptr documentToAdd(); /// To virtually destroy the fields of successors - virtual ~ModelAPI_Feature() {} - -protected: - /// Use plugin manager for features creation: this method is - /// defined here only for SWIG-wrapping - ModelAPI_Feature() - {} - - /// Sets the data manager of an object (document does) - MODELAPI_EXPORT virtual void setData(boost::shared_ptr theData) - {myData = theData;} - /// Sets the data manager of an object (document does) - MODELAPI_EXPORT void setDoc(boost::shared_ptr theDoc) {myDoc = theDoc;} - - friend class Model_Document; + MODELAPI_EXPORT virtual ~ModelAPI_Feature(); }; //! Pointer on feature object typedef boost::shared_ptr FeaturePtr; - #endif