refs #673: Strickler coefficient should be written for Telemac instead of Strickler...

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

diff --git a/src/HYDROData/HYDROData_Profile.h b/src/HYDROData/HYDROData_Profile.h
index 3c56846fa142f933433b07a7cce68611d22c3feb..5bcc450da7a182a4503ace453f15920e1c00e90d 100644 (file)
--- a/src/HYDROData/HYDROData_Profile.h
+++ b/src/HYDROData/HYDROData_Profile.h
@@ -1,3 +1,20 @@
+// Copyright (C) 2014-2015  EDF-R&D
+// 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_Profile_HeaderFile
 #define HYDROData_Profile_HeaderFile
@@ -46,7 +63,8 @@ public:
   /**
    * Dump object to Python script representation.
    */
-  HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
+  HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
+                                                     MapOfTreatedObjects& theTreatedObjects ) const;
 
   /**
    * Returns the top shape of the object.
@@ -65,15 +83,17 @@ public:
    */
   HYDRODATA_EXPORT virtual void Update();
 
+  HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
+
   /**
    * Returns default filling color for new profile.
    */
-  HYDRODATA_EXPORT static QColor DefaultFillingColor();
+  HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const;
 
   /**
    * Returns default border color for new profile.
    */
-  HYDRODATA_EXPORT static QColor DefaultBorderColor();
+  HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const;
 
 
 public:
@@ -99,28 +119,29 @@ public:
    * Set first(left) point for profile.
    * \param thePoint the point
    */
-  HYDRODATA_EXPORT void SetLeftPoint( const gp_XY& thePoint );
+  HYDRODATA_EXPORT void SetLeftPoint( const gp_XY& thePoint, bool IsConvertFromGlobal = false );
 
   /**
    * Returns first(left) point of profile.
    * \param thePoint[out] profile first point
    * \return true if point has been set
    */
-  HYDRODATA_EXPORT bool GetLeftPoint( gp_XY& thePoint ) const;
+  HYDRODATA_EXPORT bool GetLeftPoint( gp_XY& thePoint, bool IsConvertToGlobal = false,
+                                      bool CanUseDefault = false ) const;
 
   /**
    * Set last(right) point for profile.
    * \param thePoint the point
    */
-  HYDRODATA_EXPORT void SetRightPoint( const gp_XY& thePoint );
+  HYDRODATA_EXPORT void SetRightPoint( const gp_XY& thePoint, bool IsConvertFromGlobal = false );
 
   /**
    * Returns last(right) point of profile.
    * \param thePoint[out] profile last point
    * \return true if point has been set
    */
-  HYDRODATA_EXPORT bool GetRightPoint( gp_XY& thePoint ) const;
-
+  HYDRODATA_EXPORT bool GetRightPoint( gp_XY& thePoint, bool IsConvertToGlobal = false,
+                                       bool CanUseDefault = false ) const;
 
   /**
    * Returns object which store parametric presentation of profile points.
@@ -159,15 +180,28 @@ public:
    * First and last points will be automatically updated.
    * \param thePoints the list with new profile points
    */
-  HYDRODATA_EXPORT void SetProfilePoints( const ProfilePoints& thePoints );
+  HYDRODATA_EXPORT void SetProfilePoints( const ProfilePoints& thePoints, bool IsConvertFromGlobal = true );
 
   /**
    * Returns profile points.
    * Empty sequence is returned if first or last point was not set.
    * \return profile points list
    */
-  HYDRODATA_EXPORT ProfilePoints GetProfilePoints() const;
+  HYDRODATA_EXPORT ProfilePoints GetProfilePoints( bool IsConvertToGlobal = false,
+                                                   bool CanUseDefaultLeftRight = false ) const;
+
+
+  /**
+   * Return profile point with minimal Z value.
+   * \return non-parametric profile point
+   */
+  HYDRODATA_EXPORT ProfilePoint GetBottomPoint() const;
 
+  /**
+   * Return profile middle point.
+   * \return non-parametric profile point
+   */
+  HYDRODATA_EXPORT ProfilePoint GetMiddlePoint( bool CanUseDefault ) const;
 
 public:
   // Public methods to work with files.
@@ -214,23 +248,13 @@ public:
                                                 bool*      theIsRead = 0 );
 
 protected:
-
-  /**
-   * Returns default filling color for new object.
-   */
-  HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
-
-  /**
-   * Returns default border color for new object.
-   */
-  HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
-
   /**
    * Checks and if necessary create child 3D object.
    * Reimplemented to prevent creation of 3D child object.
    */
   HYDRODATA_EXPORT virtual void checkAndSetObject3D() {}
 
+  TopoDS_Shape CreateProfileWire( bool canUseDefaultPoints ) const;
 
 protected: