X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;ds=inline;f=src%2FModelAPI%2FModelAPI_Data.h;h=191345f1a7313c9359c7f17b4907d852a2dbff43;hb=acebef0bc5fb22dc9672e0046085b896e957af56;hp=f8dd2289673e932f53d9d01a26df8e5acee9c17b;hpb=0b779059afbd6c2024e1453d3133044c52bea638;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Data.h b/src/ModelAPI/ModelAPI_Data.h index f8dd22896..191345f1a 100644 --- a/src/ModelAPI/ModelAPI_Data.h +++ b/src/ModelAPI/ModelAPI_Data.h @@ -2,20 +2,29 @@ // Created: 21 Mar 2014 // Author: Mikhail PONIKAROV -#ifndef ModelAPI_Data_HeaderFile -#define ModelAPI_Data_HeaderFile +#ifndef ModelAPI_Data_H_ +#define ModelAPI_Data_H_ #include "ModelAPI.h" #include +#include +#include #include class ModelAPI_AttributeDocRef; +class ModelAPI_AttributeInteger; class ModelAPI_AttributeDouble; class ModelAPI_AttributeReference; class ModelAPI_AttributeRefAttr; class ModelAPI_AttributeRefList; +class ModelAPI_AttributeBoolean; +class ModelAPI_AttributeString; class ModelAPI_Document; class ModelAPI_Attribute; +class ModelAPI_Feature; +class ModelAPI_AttributeSelection; +class ModelAPI_AttributeSelectionList; +class GeomAPI_Shape; /**\class ModelAPI_Data * \ingroup DataModel @@ -25,52 +34,92 @@ class ModelAPI_Attribute; class MODELAPI_EXPORT ModelAPI_Data { -public: + public: /// Returns the name of the feature visible by the user in the object browser - virtual std::string getName() = 0; + virtual std::string name() = 0; /// Defines the name of the feature visible by the user in the object browser - virtual void setName(std::string theName) = 0; + virtual void setName(const std::string& theName) = 0; /// Returns the attribute that references to another document - virtual boost::shared_ptr docRef(const std::string theID) = 0; + virtual boost::shared_ptr document(const std::string& theID) = 0; /// Returns the attribute that contains real value with double precision - virtual boost::shared_ptr real(const std::string theID) = 0; + virtual boost::shared_ptr real(const std::string& theID) = 0; + /// Returns the attribute that contains integer value + virtual boost::shared_ptr integer(const std::string& theID) = 0; /// Returns the attribute that contains reference to a feature - virtual boost::shared_ptr reference(const std::string theID) = 0; + virtual boost::shared_ptr reference(const std::string& theID) = 0; + /// Returns the attribute that contains selection to a shape + virtual boost::shared_ptr selection(const std::string& theID) = 0; + /// Returns the attribute that contains selection to a shape + virtual boost::shared_ptr + selectionList(const std::string& theID) = 0; /// Returns the attribute that contains reference to an attribute of a feature - virtual boost::shared_ptr refattr(const std::string theID) = 0; + virtual boost::shared_ptr refattr(const std::string& theID) = 0; /// Returns the attribute that contains list of references to features - virtual boost::shared_ptr reflist(const std::string theID) = 0; + virtual boost::shared_ptr reflist(const std::string& theID) = 0; + /// Returns the attribute that contains boolean value + virtual boost::shared_ptr boolean(const std::string& theID) = 0; + /// Returns the attribute that contains boolean value + virtual boost::shared_ptr string(const std::string& theID) = 0; /// Returns the generic attribute by identifier /// \param theID identifier of the attribute - virtual boost::shared_ptr attribute(const std::string theID) = 0; + virtual boost::shared_ptr attribute(const std::string& theID) = 0; + /// Returns all attributes of the feature of the given type + /// or all attributes if "theType" is empty + virtual std::list > + attributes(const std::string& theType) = 0; + /// Returns all attributes ids of the feature of the given type + /// or all attributes if "theType" is empty + virtual std::list attributesIDs(const std::string& theType) = 0; /// Identifier by the id (not fast, iteration by map) /// \param theAttr attribute already created in this data - virtual const std::string& id(const boost::shared_ptr theAttr) = 0; + virtual const std::string& id(const boost::shared_ptr& theAttr) = 0; /// Returns true if data belongs to same features - virtual bool isEqual(const boost::shared_ptr theData) = 0; - /// Returns true if it is correctly connected t othe data model + virtual bool isEqual(const boost::shared_ptr& theData) = 0; + /// Returns true if it is correctly connected to the data model virtual bool isValid() = 0; /// Initializes object by the attributes: must be called just after the object is created /// for each attribute of the object /// \param theID identifier of the attribute that can be referenced by this ID later /// \param theAttrType type of the created attribute (received from the type method) - virtual void addAttribute(std::string theID, std::string theAttrType) = 0; + virtual void addAttribute(const std::string& theID, const std::string theAttrType) = 0; + + /// Useful method for "set" methods of the attributes: sends an UPDATE event and + /// makes attribute initialized + virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr) = 0; + + /// Erases all the data from the data model + virtual void erase() = 0; /// To virtually destroy the fields of successors - virtual ~ModelAPI_Data() {} + virtual ~ModelAPI_Data() + { + } + + /// Makes feature must be updated later (on rebuild). Normally the Updater must call it + /// in case of not-automatic update to true + virtual void mustBeUpdated(const bool theFlag) = 0; + + /// Returns true if feature must be updated (re-executed) on rebuild + virtual bool mustBeUpdated() = 0; -protected: + /// Returns the identifier of feature-owner, unique in this document + virtual int featureId() const = 0; + + // returns all objects referenced to this + virtual const std::set >& refsToMe() = 0; + + protected: /// Objects are created for features automatically ModelAPI_Data() - {} + { + } }; typedef boost::shared_ptr DataPtr; - #endif