src/ModelAPI/ModelAPI_Data.h

   1 // File:        ModelAPI_Data.hxx
   2 // Created:     21 Mar 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #ifndef ModelAPI_Data_HeaderFile
   6 #define ModelAPI_Data_HeaderFile
   7
   8 #include "ModelAPI.h"
   9 #include <string>
  10 #include <boost/shared_ptr.hpp>
  11
  12 class ModelAPI_AttributeDocRef;
  13 class ModelAPI_AttributeDouble;
  14 class ModelAPI_AttributeReference;
  15 class ModelAPI_AttributeRefAttr;
  16 class ModelAPI_Document;
  17 class ModelAPI_Attribute;
  18
  19 /**\class ModelAPI_Data
  20  * \ingroup DataModel
  21  * \brief General object of the application that allows
  22  * to get/set attributes from the document and compute result of an operation.
  23  */
  24
  25 class MODELAPI_EXPORT ModelAPI_Data
  26 {
  27 public:
  28
  29   /// Returns the name of the feature visible by the user in the object browser
  30   virtual std::string getName() = 0;
  31
  32   /// Defines the name of the feature visible by the user in the object browser
  33   virtual void setName(std::string theName) = 0;
  34
  35   /// Returns the attribute that references to another document
  36   virtual boost::shared_ptr<ModelAPI_AttributeDocRef> docRef(const std::string theID) = 0;
  37   /// Returns the attribute that contains real value with double precision
  38   virtual boost::shared_ptr<ModelAPI_AttributeDouble> real(const std::string theID) = 0;
  39   /// Returns the attribute that contains reference to a feature
  40   virtual boost::shared_ptr<ModelAPI_AttributeReference> reference(const std::string theID) = 0;
  41   /// Returns the attribute that contains reference to an attribute of a feature
  42   virtual boost::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string theID) = 0;
  43
  44   /// Returns the generic attribute by identifier
  45   /// \param theID identifier of the attribute
  46   virtual boost::shared_ptr<ModelAPI_Attribute> attribute(const std::string theID) = 0;
  47   /// Identifier by the id (not fast, iteration by map)
  48   /// \param theAttr attribute already created in this data
  49   virtual const std::string& id(const boost::shared_ptr<ModelAPI_Attribute> theAttr) = 0;
  50
  51   /// Initializes object by the attributes: must be called just after the object is created
  52   /// for each attribute of the object
  53   /// \param theID identifier of the attribute that can be referenced by this ID later
  54   /// \param theAttrType type of the created attribute (received from the type method)
  55   virtual void addAttribute(std::string theID, std::string theAttrType) = 0;
  56
  57   /// To virtually destroy the fields of successors
  58   virtual ~ModelAPI_Data() {}
  59
  60 protected:
  61   /// Objects are created for features automatically
  62   ModelAPI_Data()
  63   {}
  64 };
  65
  66 #endif