1 // File: ModelAPI_Data.hxx
2 // Created: 21 Mar 2014
3 // Author: Mikhail PONIKAROV
5 #ifndef ModelAPI_Data_HeaderFile
6 #define ModelAPI_Data_HeaderFile
11 #include <boost/shared_ptr.hpp>
13 class ModelAPI_AttributeDocRef;
14 class ModelAPI_AttributeDouble;
15 class ModelAPI_AttributeReference;
16 class ModelAPI_AttributeRefAttr;
17 class ModelAPI_AttributeRefList;
18 class ModelAPI_AttributeBoolean;
19 class ModelAPI_Document;
20 class ModelAPI_Attribute;
23 /**\class ModelAPI_Data
25 * \brief General object of the application that allows
26 * to get/set attributes from the document and compute result of an operation.
29 class MODELAPI_EXPORT ModelAPI_Data
33 /// Returns the name of the feature visible by the user in the object browser
34 virtual std::string getName() = 0;
36 /// Defines the name of the feature visible by the user in the object browser
37 virtual void setName(std::string theName) = 0;
39 /// Returns the attribute that references to another document
40 virtual boost::shared_ptr<ModelAPI_AttributeDocRef> docRef(const std::string theID) = 0;
41 /// Returns the attribute that contains real value with double precision
42 virtual boost::shared_ptr<ModelAPI_AttributeDouble> real(const std::string theID) = 0;
43 /// Returns the attribute that contains reference to a feature
44 virtual boost::shared_ptr<ModelAPI_AttributeReference> reference(const std::string theID) = 0;
45 /// Returns the attribute that contains reference to an attribute of a feature
46 virtual boost::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string theID) = 0;
47 /// Returns the attribute that contains list of references to features
48 virtual boost::shared_ptr<ModelAPI_AttributeRefList> reflist(const std::string theID) = 0;
49 /// Returns the attribute that contains boolean value
50 virtual boost::shared_ptr<ModelAPI_AttributeBoolean> boolean(const std::string theID) = 0;
52 /// Returns the generic attribute by identifier
53 /// \param theID identifier of the attribute
54 virtual boost::shared_ptr<ModelAPI_Attribute> attribute(const std::string theID) = 0;
55 /// Returns all attributes ofthe feature of the given type
56 /// or all attributes if "theType" is empty
57 virtual std::list<boost::shared_ptr<ModelAPI_Attribute> >
58 attributes(const std::string theType) = 0;
59 /// Identifier by the id (not fast, iteration by map)
60 /// \param theAttr attribute already created in this data
61 virtual const std::string& id(const boost::shared_ptr<ModelAPI_Attribute> theAttr) = 0;
62 /// Returns true if data belongs to same features
63 virtual bool isEqual(const boost::shared_ptr<ModelAPI_Data> theData) = 0;
64 /// Returns true if it is correctly connected t othe data model
65 virtual bool isValid() = 0;
67 /// Stores the shape (called by the execution method).
68 virtual void store(const boost::shared_ptr<GeomAPI_Shape>& theShape) = 0;
69 /// Returns the shape-result produced by this feature
70 virtual boost::shared_ptr<GeomAPI_Shape> shape() = 0;
72 /// Initializes object by the attributes: must be called just after the object is created
73 /// for each attribute of the object
74 /// \param theID identifier of the attribute that can be referenced by this ID later
75 /// \param theAttrType type of the created attribute (received from the type method)
76 virtual void addAttribute(std::string theID, std::string theAttrType) = 0;
78 /// Useful method for "set" methods of the attributes: sends an UPDATE event and
79 /// makes attribute initialized
80 virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr) = 0;
82 /// To virtually destroy the fields of successors
83 virtual ~ModelAPI_Data() {}
86 /// Objects are created for features automatically
91 typedef boost::shared_ptr<ModelAPI_Data> DataPtr;