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