src/Model/Model_Data.h

   1 // File:        Model_Data.hxx
   2 // Created:     21 Mar 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #ifndef Model_Data_HeaderFile
   6 #define Model_Data_HeaderFile
   7
   8 #include "Model.h"
   9 #include <ModelAPI_Data.h>
  10 #include <ModelAPI_Feature.h>
  11 #include <TDF_Label.hxx>
  12
  13 #include <map>
  14
  15 class ModelAPI_Attribute;
  16
  17 /**\class Model_Data
  18  * \ingroup DataModel
  19  * \brief General object of the application that allows
  20  * to get/set attributes from the document and compute result of an operation.
  21  */
  22
  23 class Model_Data: public ModelAPI_Data
  24 {
  25   TDF_Label myLab; ///< label of the feature in the document
  26   /// All attributes of the object identified by the attribute ID
  27   std::map<std::string, boost::shared_ptr<ModelAPI_Attribute> > myAttrs;
  28
  29   /// needed here to emit signal that object changed on change of the attribute
  30   ObjectPtr myObject;
  31
  32   Model_Data();
  33
  34   /// Returns label of this feature
  35   TDF_Label label() {return myLab;}
  36
  37   friend class Model_Document;
  38   friend class Model_AttributeReference;
  39   friend class Model_AttributeRefAttr;
  40   friend class Model_AttributeRefList;
  41
  42 public:
  43   /// Returns the name of the feature visible by the user in the object browser
  44   MODEL_EXPORT virtual std::string name();
  45   /// Defines the name of the feature visible by the user in the object browser
  46   MODEL_EXPORT virtual void setName(const std::string& theName);
  47   /// Returns the attribute that references to another document
  48   MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_AttributeDocRef> docRef(const std::string& theID);
  49   /// Returns the attribute that contains real value with double precision
  50   MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID);
  51   /// Returns the attribute that contains reference to a feature
  52   MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_AttributeReference>
  53     reference(const std::string& theID);
  54   /// Returns the attribute that contains reference to an attribute of a feature
  55   MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_AttributeRefAttr>
  56     refattr(const std::string& theID);
  57   /// Returns the attribute that contains list of references to features
  58   MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_AttributeRefList>
  59     reflist(const std::string& theID);
  60   /// Returns the attribute that contains boolean value
  61   MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_AttributeBoolean>
  62     boolean(const std::string& theID);
  63   /// Returns the generic attribute by identifier
  64   /// \param theID identifier of the attribute
  65   MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID);
  66   /// Returns all attributes ofthe feature of the given type
  67   /// or all attributes if "theType" is empty
  68   MODEL_EXPORT virtual std::list<boost::shared_ptr<ModelAPI_Attribute> >
  69     attributes(const std::string& theType);
  70
  71   /// Identifier by the id (not fast, iteration by map)
  72   /// \param theAttr attribute already created in this data
  73   MODEL_EXPORT virtual const std::string& id(const boost::shared_ptr<ModelAPI_Attribute>& theAttr);
  74   /// Returns true if data belongs to same features
  75   MODEL_EXPORT virtual bool isEqual(const boost::shared_ptr<ModelAPI_Data>& theData);
  76   /// Returns true if it is correctly connected t othe data model
  77   MODEL_EXPORT virtual bool isValid();
  78
  79   /// Returns the label where the shape must be stored (used in ResultBody)
  80   TDF_Label& shapeLab() {return myLab;}
  81
  82   /// Initializes object by the attributes: must be called just after the object is created
  83   /// for each attribute of the object
  84   /// \param theID identifier of the attribute that can be referenced by this ID later
  85   /// \param theAttrType type of the created attribute (received from the type method)
  86   MODEL_EXPORT virtual void addAttribute(const std::string& theID, const std::string theAttrType);
  87
  88   /// Useful method for "set" methods of the attributes: sends an UPDATE event and
  89   /// makes attribute initialized
  90   MODEL_EXPORT virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr);
  91
  92   /// Puts feature to the document data sub-structure
  93   MODEL_EXPORT void setLabel(TDF_Label theLab);
  94
  95   /// Sets the object of this data
  96   MODEL_EXPORT virtual void setObject(ObjectPtr theObject)
  97     {myObject = theObject;}
  98 };
  99
 100 #endif