Salome HOME
refs #493: draft implementation of data model part of profiles interpolation
[modules/hydro.git] / src / HYDROData / HYDROData_Document.h
index 1de23428a08d4be1d53b5148a2df943491a01bd7..bfe81778a026093ea6dbdb4f94d9fee6efa10257 100644 (file)
@@ -1,3 +1,25 @@
+// Copyright (C) 2007-2015  CEA/DEN, EDF R&D, OPEN CASCADE
+//
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
 #ifndef HYDROData_Document_HeaderFile
 #define HYDROData_Document_HeaderFile
 
@@ -6,7 +28,13 @@
 
 #include <TDocStd_Document.hxx>
 
+class HYDROData_InterpolatorsFactory;
+
 class QFile;
+class gp_Pnt2d;
+class gp_Pnt;
+class gp_XYZ;
+class gp_XY;
 
 /**
  * Errors that could appear on document open/save actions.
@@ -78,10 +106,57 @@ public:
   //! Dump study document to Python script representation.
   //! \param theFileName full name of the file to store
   //! \returns true if document has been successfuly dumped
-  HYDRODATA_EXPORT bool DumpToPython( const QString& theFileName ) const;
+  HYDRODATA_EXPORT bool DumpToPython( const QString& theFileName,
+                                      const bool     theIsMultiFile ) const;
 
   //! Dump model data to Python script representation.
-  HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
+  HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects,
+                                                     const bool           theIsMultiFile ) const;
+
+public:
+
+  // Methods to work with objects presentation.
+
+  //! Returns the order of objects presentation. Objects in returned sequence
+  //! are order from top to low depending on z-level parameter. Objects that
+  //! have no z-level parameter are located at the end of sequence and
+  //! sorted alphabetically.
+  //! Only the following types of objects considered:
+  //!   1. KIND_IMAGE
+  //!   2. KIND_IMMERSIBLE_ZONE
+  //!   3. KIND_CHANNEL
+  //!   4. KIND_RIVER
+  //!   5. KIND_STREAM
+  //!   6. KIND_OBSTACLE
+  //!   7. KIND_DIGUE
+  //!   8. KIND_POLYLINEXY
+  //!   9. KIND_ZONE
+  //! \param theIsAll if flag is true then all objects will be included,
+  //!                 otherwise only objects which have the z-level parameter
+  //! \returns ordered sequence of objects
+  HYDRODATA_EXPORT HYDROData_SequenceOfObjects GetObjectsLayerOrder( 
+    const Standard_Boolean theIsAll = Standard_True ) const;
+
+  //! Sets the order of objects presentation.
+  HYDRODATA_EXPORT void SetObjectsLayerOrder( const HYDROData_SequenceOfObjects& theOrder );
+
+  //! Show object at the top of other model objects. If the object
+  //! already has the z-level parameter then nothing will be done.
+  HYDRODATA_EXPORT void Show( const Handle_HYDROData_Entity& theObject );
+
+  //! Show sequence of objects at the top of other model objects.
+  //! The objects from the sequence will be sorted alphabetically at first.
+  HYDRODATA_EXPORT void Show( const HYDROData_SequenceOfObjects& theObjects );
+
+  //! Removes the order of objects presentation.
+  HYDRODATA_EXPORT void RemoveObjectsLayerOrder();
+
+  HYDRODATA_EXPORT void GetLocalCS( double&, double& ) const;
+  HYDRODATA_EXPORT void SetLocalCS( double, double );
+  HYDRODATA_EXPORT void Transform( double& X, double& Y, bool IsToLocalCS ) const;
+  HYDRODATA_EXPORT void Transform( gp_Pnt& thePnt, bool IsToLocalCS ) const;
+  HYDRODATA_EXPORT void Transform( gp_XYZ& thePnt, bool IsToLocalCS ) const;
+  HYDRODATA_EXPORT void Transform( gp_XY& thePnt, bool IsToLocalCS ) const;
 
 public:
 
@@ -135,6 +210,11 @@ public:
     const QStringList& theNames, 
     const ObjectKind   theObjectKind = KIND_UNKNOWN ) const;
 
+public:
+  
+  //! Returns interpolator factory instance
+  HYDROData_InterpolatorsFactory* GetInterpolatorsFactory();
+
 protected:
 
   friend class HYDROData_Iterator;
@@ -153,6 +233,8 @@ protected:
   //! Returns the label where the objects are located (used by Iterator)
   HYDRODATA_EXPORT TDF_Label LabelOfObjects();
 
+  HYDRODATA_EXPORT TDF_Label LabelOfLocalCS() const;
+
 private:
   
   // Dump header Python part in to file \c theFile
@@ -161,12 +243,17 @@ private:
 
   // Dump objects of type \c theObjectKind to file \c theFile
   bool dumpPartitionToPython( QFile&               theFile,
+                              const bool           theIsMultiFile,
                               MapOfTreatedObjects& theDumpedObjects,
                               const ObjectKind&    theObjectKind ) const;
+  void UpdateLCSFields() const;
 
 private:
   Handle(TDocStd_Document) myDoc; ///< OCAF document instance corresponding for keeping all persistent data
   int myTransactionsAfterSave; ///< number of transactions after the last "save" call, used for "IsModified" method
+  double myLX, myLY;
+
+  HYDROData_InterpolatorsFactory* myInterpolatorsFactory; ///< iterpolators factory
 };
 
 #endif