Small correction for writing of data to file.

[modules/hydro.git] / src / HYDROData / HYDROData_Object.h

diff --git a/src/HYDROData/HYDROData_Object.h b/src/HYDROData/HYDROData_Object.h
index 763153a354c764adb884fa391c5a2bb695046780..84d601560fd18e115f06b38d1bb6c3cbfe396bb6 100644 (file)
--- a/src/HYDROData/HYDROData_Object.h
+++ b/src/HYDROData/HYDROData_Object.h
@@ -3,17 +3,26 @@
 
 #include <HYDROData.h>
 
+#include <NCollection_Sequence.hxx>
 #include <TDF_Label.hxx>
-#include <QString>
+#include <QMap>
+
+class QString;
+class QStringList;
 
 ///! Kind of an object in a document
 typedef int ObjectKind;
 ///! Unrecognized object
 const ObjectKind KIND_UNKNOWN = 0;
 const ObjectKind KIND_IMAGE = 1;
+const ObjectKind KIND_POLYLINE = 2;
+const ObjectKind KIND_VISUAL_STATE = 3;
+const ObjectKind KIND_BATHYMETRY = 4;
 
 DEFINE_STANDARD_HANDLE(HYDROData_Object, MMgt_TShared)
 
+typedef QMap<QString,Handle(Standard_Transient)> MapOfTreatedObjects;
+
 /**\class HYDROData_Object
  * \brief Generic class of any object in the data model.
  *
@@ -23,6 +32,16 @@ DEFINE_STANDARD_HANDLE(HYDROData_Object, MMgt_TShared)
  */
 class HYDROData_Object : public MMgt_TShared
 {
+protected:
+  /**
+   * Enumeration of tags corresponding to the persistent object parameters.
+   */
+  enum DataTag
+  {
+    DataTag_First = 0     ///< first tag, to reserve
+    // ...
+  };
+
 public:
   DEFINE_STANDARD_RTTI(HYDROData_Object);
 
@@ -41,6 +60,14 @@ public:
    */
   HYDRODATA_EXPORT void SetName(const QString& theName);
 
+  /**
+   * Dump object to Python script representation.
+   * Base implementation returns empty list,
+   * You should reimplement this function in your derived class if it
+   * has Python API and can be imported/exported from/to Python script.
+   */
+  HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
+
   /**
    * Checks is object exists in the data structure.
    * \returns true is object is not exists in the data model
@@ -64,6 +91,11 @@ public:
    */
   HYDRODATA_EXPORT void CopyTo(Handle_HYDROData_Object theDestination) const;
 
+  /**
+   * Returns the label of this object.
+   */
+  HYDRODATA_EXPORT TDF_Label& Label() {return myLab;}
+
 protected:
 
   friend class HYDROData_Iterator;
@@ -85,11 +117,6 @@ protected:
    */
   HYDRODATA_EXPORT virtual void SetLabel(TDF_Label theLabel);
 
-  /**
-   * Returns the label of this object.
-   */
-  TDF_Label& Label() {return myLab;}
-  
   /**
    * Internal method that used to store the byte array attribute
    * \param theTag tag of a label to store attribute (for 0 this is myLab)
@@ -112,6 +139,8 @@ protected:
   TDF_Label myLab; ///< label of this object
 };
 
+typedef NCollection_Sequence<Handle_HYDROData_Object> HYDROData_SequenceOfObjects;
+
 ///! Is Equal for HYDROData_Object mapping
 HYDRODATA_EXPORT bool IsEqual(const Handle_HYDROData_Object& theObj1, const Handle_HYDROData_Object& theObj2);