src/ModelAPI/ModelAPI_Data.h

   1 // File:        ModelAPI_Data.hxx
   2 // Created:     21 Mar 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #ifndef ModelAPI_Data_H_
   6 #define ModelAPI_Data_H_
   7
   8 #include "ModelAPI.h"
   9 #include <string>
  10 #include <list>
  11 #include <boost/shared_ptr.hpp>
  12
  13 class ModelAPI_AttributeDocRef;
  14 class ModelAPI_AttributeInteger;
  15 class ModelAPI_AttributeDouble;
  16 class ModelAPI_AttributeReference;
  17 class ModelAPI_AttributeRefAttr;
  18 class ModelAPI_AttributeRefList;
  19 class ModelAPI_AttributeBoolean;
  20 class ModelAPI_AttributeString;
  21 class ModelAPI_Document;
  22 class ModelAPI_Attribute;
  23 class GeomAPI_Shape;
  24
  25 /**\class ModelAPI_Data
  26  * \ingroup DataModel
  27  * \brief General object of the application that allows
  28  * to get/set attributes from the document and compute result of an operation.
  29  */
  30
  31 class MODELAPI_EXPORT ModelAPI_Data
  32 {
  33  public:
  34
  35   /// Returns the name of the feature visible by the user in the object browser
  36   virtual std::string name() = 0;
  37
  38   /// Defines the name of the feature visible by the user in the object browser
  39   virtual void setName(const std::string& theName) = 0;
  40
  41   /// Returns the attribute that references to another document
  42   virtual boost::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID) = 0;
  43   /// Returns the attribute that contains real value with double precision
  44   virtual boost::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID) = 0;
  45   /// Returns the attribute that contains integer value
  46   virtual boost::shared_ptr<ModelAPI_AttributeInteger> integer(const std::string& theID) = 0;
  47   /// Returns the attribute that contains reference to a feature
  48   virtual boost::shared_ptr<ModelAPI_AttributeReference> reference(const std::string& theID) = 0;
  49   /// Returns the attribute that contains reference to an attribute of a feature
  50   virtual boost::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string& theID) = 0;
  51   /// Returns the attribute that contains list of references to features
  52   virtual boost::shared_ptr<ModelAPI_AttributeRefList> reflist(const std::string& theID) = 0;
  53   /// Returns the attribute that contains boolean value
  54   virtual boost::shared_ptr<ModelAPI_AttributeBoolean> boolean(const std::string& theID) = 0;
  55   /// Returns the attribute that contains boolean value
  56   virtual boost::shared_ptr<ModelAPI_AttributeString> string(const std::string& theID) = 0;
  57
  58   /// Returns the generic attribute by identifier
  59   /// \param theID identifier of the attribute
  60   virtual boost::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID) = 0;
  61   /// Returns all attributes of the feature of the given type
  62   /// or all attributes if "theType" is empty
  63   virtual std::list<boost::shared_ptr<ModelAPI_Attribute> >
  64   attributes(const std::string& theType) = 0;
  65   /// Returns all attributes ids of the feature of the given type
  66   /// or all attributes if "theType" is empty
  67   virtual std::list<std::string> attributesIDs(const std::string& theType) = 0;
  68   /// Identifier by the id (not fast, iteration by map)
  69   /// \param theAttr attribute already created in this data
  70   virtual const std::string& id(const boost::shared_ptr<ModelAPI_Attribute>& theAttr) = 0;
  71   /// Returns true if data belongs to same features
  72   virtual bool isEqual(const boost::shared_ptr<ModelAPI_Data>& theData) = 0;
  73   /// Returns true if it is correctly connected to the data model
  74   virtual bool isValid() = 0;
  75
  76   /// Initializes object by the attributes: must be called just after the object is created
  77   /// for each attribute of the object
  78   /// \param theID identifier of the attribute that can be referenced by this ID later
  79   /// \param theAttrType type of the created attribute (received from the type method)
  80   virtual void addAttribute(const std::string& theID, const std::string theAttrType) = 0;
  81
  82   /// Useful method for "set" methods of the attributes: sends an UPDATE event and
  83   /// makes attribute initialized
  84   virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr) = 0;
  85
  86   /// Erases all the data from the data model
  87   virtual void erase() = 0;
  88
  89   /// To virtually destroy the fields of successors
  90   virtual ~ModelAPI_Data()
  91   {
  92   }
  93
  94  protected:
  95   /// Objects are created for features automatically
  96   ModelAPI_Data()
  97   {
  98   }
  99 };
 100
 101 typedef boost::shared_ptr<ModelAPI_Data> DataPtr;
 102
 103 #endif