Salome HOME
Dump to Python script correction.
[modules/hydro.git] / src / HYDROData / HYDROData_Object.h
index f4b30d7076e29afafa161007657ad784a910b28d..805b593f34368136435b3052cbd4189787fa1b18 100644 (file)
@@ -1,92 +1,64 @@
+
 #ifndef HYDROData_Object_HeaderFile
 #define HYDROData_Object_HeaderFile
 
-#include <HYDROData.h>
+#include <HYDROData_Entity.h>
 
-#include <NCollection_Sequence.hxx>
-#include <TDF_Label.hxx>
-#include <QString>
+class TopoDS_Shape;
 
-///! 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;
+DEFINE_STANDARD_HANDLE(HYDROData_Object, HYDROData_Entity)
 
-DEFINE_STANDARD_HANDLE(HYDROData_Object, MMgt_TShared)
 
 /**\class HYDROData_Object
- * \brief Generic class of any object in the data model.
+ * \brief The base class for all geometrical objects in the HYDRO module.
  *
- * Interface for getting access to the object that belong to the data model.
- * Managed by Document. Provides access to the common properties: 
- * kind of an object, name.
  */
-class HYDROData_Object : public MMgt_TShared
+class HYDROData_Object : public HYDROData_Entity
 {
-public:
-  DEFINE_STANDARD_RTTI(HYDROData_Object);
-
-  /**
-   * Returns the kind of this object. Must be redefined in all objects of known type.
-   */
-  HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_UNKNOWN;}
-
-  /**
-   * Returns the name of this object.
-   */
-  HYDRODATA_EXPORT QString GetName() const;
-
-  /**
-   * Updates the name of this object.
-   */
-  HYDRODATA_EXPORT void SetName(const QString& theName);
-
+protected:
   /**
-   * Returns the object visibility state.
-   * \returns visibility state
+   * Enumeration of tags corresponding to the persistent object parameters.
    */
-  HYDRODATA_EXPORT bool GetVisibility() const;
+  enum DataTag
+  {
+    DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
+    DataTag_TopShape,
+    DataTag_Shape3D,
+  };
 
   /**
-   * Sets the object visibility state.
-   * \param theState visibility state
+   * Enumeration of tags corresponding to the child sub-objects of object.
    */
-  HYDRODATA_EXPORT void SetVisibility(bool theState);
+  enum ChildTag
+  {
+    ChildTag_First = HYDROData_Entity::ChildTag_First + 100, ///< first tag, to reserve
+  };
 
-  /**
-   * Checks is object exists in the data structure.
-   * \returns true is object is not exists in the data model
-   */
-  HYDRODATA_EXPORT bool IsRemoved() const;
+public:
+  DEFINE_STANDARD_RTTI(HYDROData_Object);
 
   /**
-   * Removes object from the data structure.
+   * Sets the top(2d projection) shape of the object.
    */
-  HYDRODATA_EXPORT void Remove();
+  HYDRODATA_EXPORT virtual void SetTopShape( const TopoDS_Shape& theShape );
 
   /**
-   * Returns unique integer identifier of the object (may be used for ordering of objects)
+   * Returns the top shape of the object.
    */
-  HYDRODATA_EXPORT inline int ID() const {return myLab.Tag();}
+  HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const = 0;
 
   /**
-   * Copies all properties of this to the destinated object.
-   * Objects must be the same type.
-   * \param theDestination initialized object (from any document) - target of copying
+   * Sets the 3d shape of the object.
    */
-  HYDRODATA_EXPORT void CopyTo(Handle_HYDROData_Object theDestination) const;
+  HYDRODATA_EXPORT virtual void SetShape3D( const TopoDS_Shape& theShape );
 
   /**
-   * Returns the label of this object.
+   * Returns the 3d shape of the object.
    */
-  HYDRODATA_EXPORT TDF_Label& Label() {return myLab;}
+  HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const = 0;
 
 protected:
 
-  friend class HYDROData_Iterator;
-
   /**
    * Creates new object in the internal data structure. Use higher level objects 
    * to create objects with real content.
@@ -98,37 +70,18 @@ protected:
    */
   virtual HYDRODATA_EXPORT ~HYDROData_Object();
 
-  /**
-   * Put the object to the label of the document.
-   * \param theLabel new label of the object
-   */
-  HYDRODATA_EXPORT virtual void SetLabel(TDF_Label theLabel);
+protected:
 
   /**
-   * Internal method that used to store the byte array attribute
-   * \param theTag tag of a label to store attribute (for 0 this is myLab)
-   * \param theData pointer to bytes array
-   * \param theLen number of bytes in byte array that must be stored
+   * Retrieve the top shape of the object from data label.
    */
-  void SaveByteArray(const int theTag, const char* theData, const int theLen);
+  HYDRODATA_EXPORT TopoDS_Shape getTopShape() const;
 
   /**
-   * Internal method that used to retreive the content of byte array attribute
-   * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
-   * \param theLen number of bytes in byte array
-   * \returns pointer to the internal data structure wit harray content, 
-   *          or NULL if array size is zero
+   * Retrieve the 3d shape of the object from data label.
    */
-  const char* ByteArray(const int theTag, int& theLen);
+  HYDRODATA_EXPORT TopoDS_Shape getShape3D() const;
 
-protected:
-  /// Array of pointers to the properties of this object; index in this array is returned by \a AddProperty.
-  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);
-
 #endif