Salome HOME
#refs 522 (very draft) //import only
[modules/hydro.git] / src / HYDROData / HYDROData_Tool.h
index 5be4ba3ab2e65b366605a09a4e167b4ed4ec81c7..eab582db707ce1b6616b4759d51671c6a1b05c9a 100644 (file)
@@ -1,15 +1,46 @@
+// 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_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 QFile;
-class QStringList;
+class TopoDS_Shape;
+class TopTools_SequenceOfShape;
+class Handle(HYDROData_Document);
 
-class HYDROData_Tool {
+class HYDRODATA_EXPORT HYDROData_Tool {
 
 public:
 
@@ -17,6 +48,57 @@ public:
                                                             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 )