Salome HOME
refs #430: incorrect coordinates in dump polyline
[modules/hydro.git] / src / HYDROData / HYDROData_Tool.h
index e2306013ba25e6ee04b662125eace51d1e895a50..bb71d8c466912899e249743731237046487b1dc0 100644 (file)
@@ -2,15 +2,82 @@
 #ifndef HYDROData_Tool_HeaderFile
 #define HYDROData_Tool_HeaderFile
 
+#include "HYDROData.h"
+#include "HYDROData_Entity.h"
+
 #include <Precision.hxx>
 
+#include <TopAbs_ShapeEnum.hxx>
 
+#include <QString>
+#include <QStringList>
+#include <gp_XY.hxx>
+#include <TopoDS_Face.hxx>
 
-class HYDROData_Tool {
+class QFile;
+class TopoDS_Shape;
+class TopTools_SequenceOfShape;
+class Handle(HYDROData_Document);
 
-public:
+class HYDRODATA_EXPORT HYDROData_Tool {
 
+public:
 
+  static void                           WriteStringsToFile( QFile&             theFile,
+                                                            const QStringList& theStrings,
+                                                            const QString&     theSep = "\n" );
+
+  /**
+   * Enables "MustBeUpdated" flag for objects that are depended on "MustBeUpdated" objects.
+   * \param theDoc document where this operation is performed
+   */
+  static void                           SetMustBeUpdatedObjects( const Handle(HYDROData_Document)& theDoc );
+
+  /**
+   * \brief Generate name for new object.
+   * \param theDoc document
+   * \param thePrefix name prefix
+   * \param theUsedNames list of already used names
+   * \param theIsTryToUsePurePrefix if true - the prefix will be returned if the name equal to the prefix is not busy
+   * \return generated name
+   */
+  static QString                        GenerateObjectName( const Handle(HYDROData_Document)& theDoc,
+                                                            const QString&                    thePrefix,
+                                                            const QStringList&                theUsedNames = QStringList(),
+                                                            const bool                        theIsTryToUsePurePrefix = false );
+
+  /**
+   * \brief Checks the type of object.
+   * \param theObject object to check
+   * \return true if object is geometry object
+   */
+  static bool                           IsGeometryObject( const Handle(HYDROData_Entity)& theObject );
+
+  /**
+   * \brief Updates the child object name.
+   * \param theOldStr old father object name
+   * \param theNewStr new father object name
+   * \param theObject object to update
+   */
+  static void                           UpdateChildObjectName( const QString&                  theOldStr,
+                                                               const QString&                  theNewStr,
+                                                               const Handle(HYDROData_Entity)& theObject );
+
+
+  /**
+   * \brief Generate name for new object in python environment.
+   * \param theTreatedObjects objects which was alredy created by dump operation
+   * \param thePrefix name prefix
+   * \return generated name
+   */
+  static QString                        GenerateNameForPython( const MapOfTreatedObjects& theTreatedObjects,
+                                                               const QString&             thePrefix );
+ /**
+  * Computes Point State from TopAbs (simplified & limited method).
+  */
+
+ static TopAbs_State                    ComputePointState( const gp_XY& thePnt2d, 
+                                                              const TopoDS_Face& theFace );
 };
 
 inline bool ValuesEquals( const double& theFirst, const double& theSecond )