src/HYDROData/HYDROData_Entity.h

   1
   2 #ifndef HYDROData_Entity_HeaderFile
   3 #define HYDROData_Entity_HeaderFile
   4
   5 #include "HYDROData.h"
   6
   7 #include <NCollection_Sequence.hxx>
   8
   9 #include <TDF_Label.hxx>
  10
  11 #include <QMap>
  12
  13 class QColor;
  14 class QString;
  15 class QVariant;
  16 class QStringList;
  17 class Handle(TDataStd_ReferenceList);
  18 class Handle_HYDROData_Entity;
  19
  20 ///! Kind of an object in a document
  21 typedef int ObjectKind;
  22
  23 const ObjectKind KIND_UNKNOWN           = 0; ///! Unrecognized object
  24 const ObjectKind KIND_IMAGE             = 1;
  25 const ObjectKind KIND_POLYLINE          = 2;
  26 const ObjectKind KIND_BATHYMETRY        = 3;
  27 const ObjectKind KIND_ALTITUDE          = 4;
  28 const ObjectKind KIND_IMMERSIBLE_ZONE   = 5;
  29 const ObjectKind KIND_RIVER             = 6;
  30 const ObjectKind KIND_STREAM            = 7;
  31 const ObjectKind KIND_CONFLUENCE        = 8;
  32 const ObjectKind KIND_CHANNEL           = 9;
  33 const ObjectKind KIND_OBSTACLE          = 10;
  34 const ObjectKind KIND_DIGUE             = 11;
  35 const ObjectKind KIND_PROFILE           = 12;
  36 const ObjectKind KIND_PROFILEUZ         = 13;
  37 const ObjectKind KIND_POLYLINEXY        = 14;
  38 const ObjectKind KIND_CALCULATION       = 15;
  39 const ObjectKind KIND_ZONE              = 16;
  40 const ObjectKind KIND_REGION            = 17;
  41 const ObjectKind KIND_VISUAL_STATE      = 18;
  42 const ObjectKind KIND_ARTIFICIAL_OBJECT = 19;
  43 const ObjectKind KIND_NATURAL_OBJECT    = 20;
  44 const ObjectKind KIND_LAST              = KIND_NATURAL_OBJECT;
  45
  46 DEFINE_STANDARD_HANDLE(HYDROData_Entity, MMgt_TShared)
  47
  48 typedef QMap<QString,Handle(Standard_Transient)> MapOfTreatedObjects;
  49
  50 typedef NCollection_Sequence<Handle_HYDROData_Entity> HYDROData_SequenceOfObjects;
  51
  52
  53 /**\class HYDROData_Entity
  54  * \brief Generic class of any object in the data model.
  55  *
  56  * Interface for getting access to the object that belong to the data model.
  57  * Managed by Document. Provides access to the common properties:
  58  * kind of an object, name.
  59  */
  60 class HYDROData_Entity : public MMgt_TShared
  61 {
  62
  63 protected:
  64
  65   /**
  66    * Enumeration of tags corresponding to the persistent object parameters.
  67    */
  68   enum DataTag
  69   {
  70     DataTag_First = 0     ///< first tag, to reserve
  71     // ...
  72   };
  73
  74 public:
  75   DEFINE_STANDARD_RTTI(HYDROData_Entity);
  76
  77   /**
  78    * Returns the kind of this object. Must be redefined in all objects of known type.
  79    */
  80   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_UNKNOWN; }
  81
  82   /**
  83    * Returns the name of this object.
  84    */
  85   HYDRODATA_EXPORT virtual QString GetName() const;
  86
  87   /**
  88    * Updates the name of this object.
  89    */
  90   HYDRODATA_EXPORT virtual void SetName( const QString& theName );
  91
  92   /**
  93    * Dump object to Python script representation.
  94    * Base implementation returns empty list,
  95    * You should reimplement this function in your derived class if it
  96    * has Python API and can be imported/exported from/to Python script.
  97    */
  98   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
  99
 100   /**
 101    * Updates object state. Base implementation dose nothing.
 102    */
 103   HYDRODATA_EXPORT virtual void Update();
 104
 105   /**
 106    * Returns data of object wrapped to QVariant.
 107    * Base implementation returns null value.
 108    */
 109   HYDRODATA_EXPORT virtual QVariant GetDataVariant();
 110
 111
 112   /**
 113    * Sets the "MustBeUpdated" flag: if object is depended on updated features.
 114    * \param theFlag is true for objects that must be updated, false for up-to-date
 115    */
 116   HYDRODATA_EXPORT virtual void SetToUpdate( bool theFlag );
 117
 118   /**
 119    * Returns the "MustBeUpdated" flag: is object data must be updated or not
 120    * \returns false if object is up to date
 121    */
 122   HYDRODATA_EXPORT virtual bool IsMustBeUpdated() const;
 123
 124   /**
 125    * Returns flag indicating that object is updateble or not.
 126    */
 127   HYDRODATA_EXPORT virtual bool CanBeUpdated() const;
 128
 129
 130   /**
 131    * Checks is object exists in the data structure.
 132    * \returns true is object is not exists in the data model
 133    */
 134   HYDRODATA_EXPORT bool IsRemoved() const;
 135
 136   /**
 137    * Removes object and it child sub-objects from the data structure.
 138    */
 139   HYDRODATA_EXPORT virtual void Remove();
 140
 141   /**
 142    * Returns flag indicating that object can be removed or not.
 143    * Reimplement this method in class which can't be removed
 144    * separately with it parent object.
 145    * Base implementaiton returns always TRUE.
 146    */
 147   HYDRODATA_EXPORT virtual bool CanRemove();
 148
 149   /**
 150    * Returns unique integer identifier of the object (may be used for ordering of objects)
 151    */
 152   HYDRODATA_EXPORT inline int ID() const { return myLab.Tag(); }
 153
 154   /**
 155    * Copies all properties of this to the destinated object.
 156    * Objects must be the same type.
 157    * \param theDestination initialized object (from any document) - target of copying
 158    */
 159   HYDRODATA_EXPORT void CopyTo( Handle_HYDROData_Entity theDestination ) const;
 160
 161   /**
 162    * Returns the label of this object.
 163    */
 164   HYDRODATA_EXPORT TDF_Label& Label() { return myLab; }
 165
 166
 167   /**
 168    * Returns father object. For object created under root document label
 169    * this method always return NULL object.
 170    */
 171   HYDRODATA_EXPORT virtual Handle(HYDROData_Entity) GetFatherObject() const;
 172
 173
 174   /**
 175    * Returns the list of all reference objects of this object.
 176    * Base implementation always return empty list.
 177    */
 178   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
 179
 180
 181 protected:
 182
 183   friend class HYDROData_Iterator;
 184
 185   /**
 186    * Creates new object in the internal data structure. Use higher level objects
 187    * to create objects with real content.
 188    */
 189   HYDRODATA_EXPORT HYDROData_Entity();
 190
 191   /**
 192    * Destructs properties of the object and object itself, removes it from the document.
 193    */
 194   virtual HYDRODATA_EXPORT ~HYDROData_Entity();
 195
 196   /**
 197    * Put the object to the label of the document.
 198    * \param theLabel new label of the object
 199    */
 200   HYDRODATA_EXPORT virtual void SetLabel(TDF_Label theLabel);
 201
 202   /**
 203    * Internal method that used to store the byte array attribute
 204    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 205    * \param theData pointer to bytes array
 206    * \param theLen number of bytes in byte array that must be stored
 207    */
 208   void SaveByteArray(const int theTag, const char* theData, const int theLen);
 209
 210   /**
 211    * Internal method that used to retreive the content of byte array attribute
 212    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 213    * \param theLen number of bytes in byte array
 214    * \returns pointer to the internal data structure wit harray content,
 215    *          or NULL if array size is zero
 216    */
 217   const char* ByteArray(const int theTag, int& theLen) const;
 218
 219   /**
 220    * Internal method that used to store the reference object label attribute
 221    * \param theObj pointer to reference object
 222    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 223    */
 224   int NbReferenceObjects( const int theTag = 0 ) const;
 225
 226   /**
 227    * Internal method that used to check object for entry into the reference list
 228    * \param theObj pointer to reference object
 229    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 230    */
 231   bool HasReference( const Handle_HYDROData_Entity& theObj,
 232                      const int                      theTag = 0 ) const;
 233
 234   /**
 235    * Internal method that used to store the reference object label attribute
 236    * \param theObj pointer to reference object
 237    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 238    */
 239   void AddReferenceObject( const Handle_HYDROData_Entity& theObj,
 240                            const int                      theTag = 0 );
 241
 242   /**
 243    * Internal method that used to store the reference object label attribute
 244    * \param theObj pointer to reference object
 245    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 246    * \param theIndex index in the list of references
 247              - if more that len then just append it to the end of list
 248              - if less than zero then prepend to the list
 249              - indexing starts from 0
 250    */
 251   void SetReferenceObject( const Handle_HYDROData_Entity& theObj,
 252                            const int                      theTag = 0,
 253                            const int                      theIndex = 0 );
 254
 255   /**
 256    * Internal method that used to store the reference object label attribute
 257    * \param theObj pointer to reference object
 258    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 259    * \param theBeforeIndex index in the list of references
 260              - if more that len then just append it to the end of list
 261              - if less than zero then prepend to the list
 262              - indexing starts from 0
 263    */
 264   void InsertReferenceObject( const Handle_HYDROData_Entity& theObj,
 265                               const int                      theTag = 0,
 266                               const int                      theBeforeIndex = 0 );
 267
 268   /**
 269    * Internal method that used to store the reference object label attribute
 270    * \param theObjects sequence with pointers to reference objects
 271    * \param theTag tag of a label to store attribute (for 0 this is myLab)
 272    */
 273   void SetReferenceObjects( const HYDROData_SequenceOfObjects& theObjects,
 274                             const int                          theTag = 0 );
 275
 276   /**
 277    * Internal method that used to retreive the reference object(s) attribute
 278    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 279    * \param theIndex index in the list of references
 280    *        - indexing starts from 0
 281    * \returns pointer to reference object or NULL if label is not set
 282    */
 283   Handle_HYDROData_Entity GetReferenceObject( const int theTag   = 0,
 284                                               const int theIndex = 0 ) const;
 285
 286   HYDROData_SequenceOfObjects GetReferenceObjects( const int theTag = 0 ) const;
 287
 288   /**
 289    * Internal method that used to remove the reference object attribute
 290    * \param theRefLabel reference object label to remove
 291    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 292    */
 293   void RemoveReferenceObject( const TDF_Label& theRefLabel, const int theTag = 0 );
 294
 295   /**
 296    * Internal method that used to remove the reference object attribute
 297    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 298    * \param theIndex index in the list of references
 299    *        - indexing starts from 0
 300    */
 301   void RemoveReferenceObject( const int theTag = 0, const int theIndex = 0 );
 302
 303   /**
 304    * Internal method that used to clear list of the reference objects attribute
 305    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 306    */
 307   void ClearReferenceObjects( const int theTag = 0 );
 308
 309   /**
 310    * Internal method that used to store the color attribute
 311    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 312    * \param theColor color to save
 313    */
 314   void SetColor( const QColor& theColor, const int theTag = 0 );
 315
 316   /**
 317    * Internal method that used to retreive the color attribute
 318    * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
 319    * \param theDefColor default color to return if attribute has not been set before
 320    */
 321   QColor GetColor( const QColor& theDefColor, const int theTag = 0 ) const;
 322
 323
 324 protected:
 325
 326   void setPythonReferenceObject( MapOfTreatedObjects&            theTreatedObjects,
 327                                  QStringList&                    theScript,
 328                                  const Handle(HYDROData_Entity)& theRefObject,
 329                                  const QString&                  theMethod ) const;
 330 protected:
 331
 332   Handle(TDataStd_ReferenceList) getReferenceList( const int  theTag,
 333                                                    const bool theIsCreate ) const;
 334
 335
 336 protected:
 337   /// Array of pointers to the properties of this object; index in this array is returned by \a AddProperty.
 338   TDF_Label myLab; ///< label of this object
 339 };
 340
 341 ///! Is Equal for HYDROData_Entity mapping
 342 HYDRODATA_EXPORT bool IsEqual(const Handle_HYDROData_Entity& theObj1, const Handle_HYDROData_Entity& theObj2);
 343
 344 #endif