src/HYDROData/HYDROData_Object.h

   1 #ifndef HYDROData_Object_HeaderFile
   2 #define HYDROData_Object_HeaderFile
   3
   4 #include <HYDROData.h>
   5
   6 #include <NCollection_Sequence.hxx>
   7 #include <TDF_Label.hxx>
   8 #include <QMap>
   9
  10 class QString;
  11 class QVariant;
  12 class QStringList;
  13
  14 ///! Kind of an object in a document
  15 typedef int ObjectKind;
  16 ///! Unrecognized object
  17 const ObjectKind KIND_UNKNOWN = 0;
  18 const ObjectKind KIND_IMAGE = 1;
  19 const ObjectKind KIND_POLYLINE = 2;
  20 const ObjectKind KIND_VISUAL_STATE = 3;
  21 const ObjectKind KIND_BATHYMETRY = 4;
  22 const ObjectKind KIND_CALCULATION = 5;
  23
  24 DEFINE_STANDARD_HANDLE(HYDROData_Object, MMgt_TShared)
  25
  26 typedef QMap<QString,Handle(Standard_Transient)> MapOfTreatedObjects;
  27
  28 /**\class HYDROData_Object
  29  * \brief Generic class of any object in the data model.
  30  *
  31  * Interface for getting access to the object that belong to the data model.
  32  * Managed by Document. Provides access to the common properties:
  33  * kind of an object, name.
  34  */
  35 class HYDROData_Object : public MMgt_TShared
  36 {
  37 protected:
  38   /**
  39    * Enumeration of tags corresponding to the persistent object parameters.
  40    */
  41   enum DataTag
  42   {
  43     DataTag_First = 0     ///< first tag, to reserve
  44     // ...
  45   };
  46
  47 public:
  48   DEFINE_STANDARD_RTTI(HYDROData_Object);
  49
  50   /**
  51    * Returns the kind of this object. Must be redefined in all objects of known type.
  52    */
  53   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_UNKNOWN;}
  54
  55   /**
  56    * Returns the name of this object.
  57    */
  58   HYDRODATA_EXPORT QString GetName() const;
  59
  60   /**
  61    * Updates the name of this object.
  62    */
  63   HYDRODATA_EXPORT void SetName(const QString& theName);
  64
  65   /**
  66    * Dump object to Python script representation.
  67    * Base implementation returns empty list,
  68    * You should reimplement this function in your derived class if it
  69    * has Python API and can be imported/exported from/to Python script.
  70    */
  71   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
  72
  73   /**
  74    * Updates object state.
  75    * Base implementation dose nothing.
  76    */
  77   HYDRODATA_EXPORT virtual void Update();
  78
  79   /**
  80    * Returns data of object wrapped to QVariant.
  81    * Base implementation returns null value.
  82    */
  83   HYDRODATA_EXPORT virtual QVariant GetDataVariant();
  84
  85   /**
  86    * Checks is object exists in the data structure.
  87    * \returns true is object is not exists in the data model
  88    */
  89   HYDRODATA_EXPORT bool IsRemoved() const;
  90
  91   /**
  92    * Removes object from the data structure.
  93    */
  94   HYDRODATA_EXPORT void Remove();
  95
  96   /**
  97    * Returns unique integer identifier of the object (may be used for ordering of objects)
  98    */
  99   HYDRODATA_EXPORT inline int ID() const {return myLab.Tag();}
 100
 101   /**
 102    * Copies all properties of this to the destinated object.
 103    * Objects must be the same type.
 104    * \param theDestination initialized object (from any document) - target of copying
 105    */
 106   HYDRODATA_EXPORT void CopyTo(Handle_HYDROData_Object theDestination) const;
 107
 108   /**
 109    * Returns the label of this object.
 110    */
 111   HYDRODATA_EXPORT TDF_Label& Label() {return myLab;}
 112
 113 protected:
 114
 115   friend class HYDROData_Iterator;
 116
 117   /**
 118    * Creates new object in the internal data structure. Use higher level objects
 119    * to create objects with real content.
 120    */
 121   HYDRODATA_EXPORT HYDROData_Object();
 122
 123   /**
 124    * Destructs properties of the object and object itself, removes it from the document.
 125    */
 126   virtual HYDRODATA_EXPORT ~HYDROData_Object();
 127
 128   /**
 129    * Put the object to the label of the document.
 130    * \param theLabel new label of the object
 131    */
 132   HYDRODATA_EXPORT virtual void SetLabel(TDF_Label theLabel);
 133
 134   /**
 135    * Internal method that used to store the byte array attribute
 136    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 137    * \param theData pointer to bytes array
 138    * \param theLen number of bytes in byte array that must be stored
 139    */
 140   void SaveByteArray(const int theTag, const char* theData, const int theLen);
 141
 142   /**
 143    * Internal method that used to retreive the content of byte array attribute
 144    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 145    * \param theLen number of bytes in byte array
 146    * \returns pointer to the internal data structure wit harray content,
 147    *          or NULL if array size is zero
 148    */
 149   const char* ByteArray(const int theTag, int& theLen) const;
 150
 151 protected:
 152   /// Array of pointers to the properties of this object; index in this array is returned by \a AddProperty.
 153   TDF_Label myLab; ///< label of this object
 154 };
 155
 156 typedef NCollection_Sequence<Handle_HYDROData_Object> HYDROData_SequenceOfObjects;
 157
 158 ///! Is Equal for HYDROData_Object mapping
 159 HYDRODATA_EXPORT bool IsEqual(const Handle_HYDROData_Object& theObj1, const Handle_HYDROData_Object& theObj2);
 160
 161 #endif