X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Feature.h;h=a6c51d0407958d4831cc29773cc8e127aec5e9d1;hb=9eb5801ea57b763b26db2c7bf897a50b34e2cc31;hp=8c1a82e75e2a3a22380065e42dab13463cba0662;hpb=9fb117423f35d7271d96badbe4b8ec320641bc6e;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Feature.h b/src/ModelAPI/ModelAPI_Feature.h index 8c1a82e75..a6c51d040 100644 --- a/src/ModelAPI/ModelAPI_Feature.h +++ b/src/ModelAPI/ModelAPI_Feature.h @@ -2,60 +2,91 @@ // Created: 21 Mar 2014 // Author: Mikhail PONIKAROV -#ifndef ModelAPI_Feature_HeaderFile -#define ModelAPI_Feature_HeaderFile +#ifndef ModelAPI_Feature_H_ +#define ModelAPI_Feature_H_ -#include "ModelAPI.h" -#include "ModelAPI_PluginManager.h" +#include "ModelAPI_Object.h" +#include "ModelAPI_Session.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 + ///< list of current results of this feature + std::list > myResults; + public: + /// Returns the unique kind of a feature (like "Point") + virtual const std::string& getKind() = 0; -public: - /// Returns the kind of a feature (like "Point") - MODELAPI_EXPORT 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 the data manager of this feature - MODELAPI_EXPORT virtual boost::shared_ptr data() {return myData;} + /// 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); + /// removes the result from the feature + MODELAPI_EXPORT void removeResult(const boost::shared_ptr& theResult); + /// removes all results from the feature + MODELAPI_EXPORT void eraseResults(); + /// removes all fields from this feature: results, data, etc + MODELAPI_EXPORT virtual void erase(); + + /// Returns true if result is persistent (stored in document) and on undo-redo, save-open + /// it is not needed to recompute it. + virtual bool isPersistentResult() {return true;} + + /// Returns true if this feature must not be created: this is just an action + /// 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();} + MODELAPI_EXPORT virtual boost::shared_ptr documentToAdd(); /// To virtually destroy the fields of successors - virtual ~ModelAPI_Feature() {} + MODELAPI_EXPORT virtual ~ModelAPI_Feature(); -protected: - /// Use plugin manager for features creation: this method is - /// defined here only for SWIG-wrapping - ModelAPI_Feature() - {} + MODELAPI_EXPORT static boost::shared_ptr feature(ObjectPtr theObject); - /// Sets the data manager of an object (document does) - MODELAPI_EXPORT void setData(boost::shared_ptr theData) {myData = theData;} - friend class Model_Document; }; +//! Pointer on feature object +typedef boost::shared_ptr FeaturePtr; + #endif