X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Feature.h;h=b80583544021bd7afc1f74b9129df94f246166f5;hb=a11ca8e50848c291ed13f920168622937ae3b8dc;hp=3770c06f02a00bb9d522b0ca2642485f77efa42e;hpb=63e86d82608e83f49339f946a8a3f5ebcaa0f7b5;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Feature.h b/src/ModelAPI/ModelAPI_Feature.h index 3770c06f0..b80583544 100644 --- a/src/ModelAPI/ModelAPI_Feature.h +++ b/src/ModelAPI/ModelAPI_Feature.h @@ -1,20 +1,21 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: ModelAPI_Feature.hxx // 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_Object.h" -#include "ModelAPI_PluginManager.h" +#include +#include +#include +#include -#include -#include -#include +#include -class ModelAPI_Data; -class ModelAPI_Document; -class ModelAPI_Result; +#include +#include /**\class ModelAPI_Feature * \ingroup DataModel @@ -24,47 +25,157 @@ class ModelAPI_Result; class ModelAPI_Feature : public ModelAPI_Object { ///< list of current results of this feature - std::list > myResults; -public: + std::list > myResults; + public: /// 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;} + inline static std::string group() + { + static std::string MY_GROUP = "Features"; + return MY_GROUP; + } - /// Returns the group identifier of this result - virtual std::string groupName() { return group(); } + /// Returns document this feature belongs to + virtual std::shared_ptr document() const + { + return ModelAPI_Object::document(); + } - /// Request for initialization of data model of the feature: adding all attributes - virtual void initAttributes() = 0; + /// Returns the group identifier of this result + virtual std::string groupName() + { + return group(); + } /// Computes or recomputes the results virtual void execute() = 0; + /// Computes the attribute value on the base of other attributes if the value can be computed + /// \param theAttributeId an attribute index to be computed + /// \return a boolean value about it is computed + virtual bool compute(const std::string& theAttributeId) { return false; }; + + /// Registers error during the execution, causes the ExecutionFailed state + virtual void setError(const std::string& theError, bool isSend = true) { + data()->setError(theError, isSend); + } + + /// Returns error, arose during the execution + virtual std::string error() const { + return data()->error(); + } + /// returns the current results of the feature - std::list >& results() {return myResults;} + MODELAPI_EXPORT const std::list >& results(); /// returns the first result in the list or NULL reference - boost::shared_ptr firstResult() - {return myResults.empty() ? boost::shared_ptr() : *(myResults.begin());} + MODELAPI_EXPORT std::shared_ptr firstResult(); + /// returns the last result in the list or NULL reference + MODELAPI_EXPORT std::shared_ptr lastResult(); /// sets the alone result - void setResult(const boost::shared_ptr& theResult) - {myResults.clear(); myResults.push_back(theResult);} + MODELAPI_EXPORT void setResult(const std::shared_ptr& theResult); + /// sets the result by index (zero based), results before this must be set before + MODELAPI_EXPORT void setResult(const std::shared_ptr& theResult, + const int theIndex); + /// removes the result from the feature + MODELAPI_EXPORT void removeResult(const std::shared_ptr& theResult); + /// removes all results starting from the gived index (zero-based) + MODELAPI_EXPORT void removeResults(const int theSinceIndex); + /// 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;} + virtual bool isAction() + { + return false; + } /// Must return document where the new feature must be added to - /// By default it is current document - virtual boost::shared_ptr documentToAdd() - {return ModelAPI_PluginManager::get()->currentDocument();} + /// By default it is null document: it is added to the document this method is called to + MODELAPI_EXPORT virtual std::shared_ptr documentToAdd(); /// To virtually destroy the fields of successors - virtual ~ModelAPI_Feature() {} + MODELAPI_EXPORT virtual ~ModelAPI_Feature(); + + /// Returns the feature by the object (result). + MODELAPI_EXPORT static std::shared_ptr feature(ObjectPtr theObject); + + // + // Helper methods, aliases for data()->method() + // ----------------------------------------------------------------------------------------------- + /// Returns the name stored in the attribute + inline std::string name() + { + return data()->name(); + } + /// Returns the Boolean attribute by the identifier + inline std::shared_ptr boolean(const std::string& theID) + { + return data()->boolean(theID); + } + /// Returns the document reference attribute + inline std::shared_ptr document(const std::string& theID) + { + return data()->document(theID); + } + /// Returns the real attribute by the identifier + inline std::shared_ptr real(const std::string& theID) + { + return data()->real(theID); + } + /// Returns the integer attribute by the identifier + inline std::shared_ptr integer(const std::string& theID) + { + return data()->integer(theID); + } + /// Returns the reference attribute by the identifier + inline std::shared_ptr refattr(const std::string& theID) + { + return data()->refattr(theID); + } + /// Returns the reference attribute by the identifier + inline std::shared_ptr reference(const std::string& theID) + { + return data()->reference(theID); + } + /// Returns the list of references attribute by the identifier + inline std::shared_ptr reflist(const std::string& theID) + { + return data()->reflist(theID); + } + /// Returns the shape selection attribute by the identifier + inline std::shared_ptr selection(const std::string& theID) + { + return data()->selection(theID); + } + /// Returns the list of shape selections attribute by the identifier + inline std::shared_ptr selectionList(const std::string& theID) + { + return data()->selectionList(theID); + } + /// Returns the string attribute by the identifier + inline std::shared_ptr string(const std::string& theID) + { + return data()->string(theID); + } + /// Returns the attribute by the identifier + inline std::shared_ptr attribute(const std::string& theID) + { + return data()->attribute(theID); + } + // ----------------------------------------------------------------------------------------------- }; //! Pointer on feature object -typedef boost::shared_ptr FeaturePtr; +typedef std::shared_ptr FeaturePtr; #endif +