X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Feature.h;h=c266b505ea1a194910a7ab7a020a72b448717532;hb=94ba553e7b92f11a936e027b49bbd1d501eeee44;hp=8c1a82e75e2a3a22380065e42dab13463cba0662;hpb=6654a921211670c15a79a997ca666a174fe8a6f6;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Feature.h b/src/ModelAPI/ModelAPI_Feature.h index 8c1a82e75..c266b505e 100644 --- a/src/ModelAPI/ModelAPI_Feature.h +++ b/src/ModelAPI/ModelAPI_Feature.h @@ -2,60 +2,177 @@ // 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 +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include -#include #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 document this feature belongs to + virtual boost::shared_ptr document() const + { + return ModelAPI_Object::document(); + } + + /// 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 results + virtual void execute() = 0; - /// Computes or recomputes the result - MODELAPI_EXPORT virtual void execute() = 0; + /// 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(); + /// returns the last result in the list or NULL reference + MODELAPI_EXPORT boost::shared_ptr lastResult(); + /// 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 the data manager of this feature - MODELAPI_EXPORT virtual boost::shared_ptr data() {return myData;} + /// 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(); + + MODELAPI_EXPORT static boost::shared_ptr feature(ObjectPtr theObject); + + // + // Helper methods, aliases for data()->method() + // ----------------------------------------------------------------------------------------------- + inline std::string name() + { + return data()->name(); + } + + inline boost::shared_ptr boolean(const std::string& theID) + { + return data()->boolean(theID); + } + + inline boost::shared_ptr document(const std::string& theID) + { + return data()->document(theID); + } -protected: - /// Use plugin manager for features creation: this method is - /// defined here only for SWIG-wrapping - ModelAPI_Feature() - {} + inline boost::shared_ptr real(const std::string& theID) + { + return data()->real(theID); + } - /// Sets the data manager of an object (document does) - MODELAPI_EXPORT void setData(boost::shared_ptr theData) {myData = theData;} - friend class Model_Document; + inline boost::shared_ptr integer(const std::string& theID) + { + return data()->integer(theID); + } + + inline boost::shared_ptr refattr(const std::string& theID) + { + return data()->refattr(theID); + } + + inline boost::shared_ptr reference(const std::string& theID) + { + return data()->reference(theID); + } + + inline boost::shared_ptr reflist(const std::string& theID) + { + return data()->reflist(theID); + } + + inline boost::shared_ptr selection(const std::string& theID) + { + return data()->selection(theID); + } + + inline boost::shared_ptr selectionList(const std::string& theID) + { + return data()->selectionList(theID); + } + + inline boost::shared_ptr string(const std::string& theID) + { + return data()->string(theID); + } + + inline boost::shared_ptr attribute(const std::string& theID) + { + return data()->attribute(theID); + } + // ----------------------------------------------------------------------------------------------- }; +//! Pointer on feature object +typedef boost::shared_ptr FeaturePtr; + #endif +