Salome HOME
The data model has been rolled back to previous version.
[modules/hydro.git] / src / HYDROData / HYDROData_Tool.h
index e2306013ba25e6ee04b662125eace51d1e895a50..a1fc83373496e5a1a6d8424d86bb7792769ac627 100644 (file)
@@ -2,14 +2,72 @@
 #ifndef HYDROData_Tool_HeaderFile
 #define HYDROData_Tool_HeaderFile
 
+#include "HYDROData.h"
+#include "HYDROData_Entity.h"
+
 #include <Precision.hxx>
 
+#include <QString>
+#include <QStringList>
 
+class QFile;
+class Handle(HYDROData_Document);
 
-class HYDROData_Tool {
+class HYDRODATA_EXPORT HYDROData_Tool {
 
 public:
 
+  static void                           WriteStringsToFile( QFile&             theFile,
+                                                            const QStringList& theStrings,
+                                                            const QString&     theSep = "\n" );
+
+  /**
+   * Enables "MustBeUpdated" flag for Images that are depended on "MustBeUpdated" images.
+   * \param theDoc document where this operation is performed
+   */
+  static void                           SetMustBeUpdatedImages( const Handle(HYDROData_Document)& theDoc );
+
+  /**
+   * \brief Generate name for new object.
+   * \param theModule module
+   * \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 Find the data object with the specified name.
+   * \param theModule module
+   * \param theName name
+   * \param theObjectKind kind of object
+   * \return data object
+   */
+  static Handle(HYDROData_Entity)       FindObjectByName( const Handle(HYDROData_Document)& theDoc,
+                                                          const QString&                    theName,
+                                                          const ObjectKind                  theObjectKind = KIND_UNKNOWN );
+
+  /**
+   * \brief Find the data objects with the specified names.
+   * \param theModule module
+   * \param theNames list of names
+   * \param theObjectKind kind of object
+   * \return list of data objects
+   */
+  static HYDROData_SequenceOfObjects    FindObjectsByNames( const Handle(HYDROData_Document)& theDoc,
+                                                            const QStringList&                theNames,
+                                                            const ObjectKind                  theObjectKind = KIND_UNKNOWN );
+
+  /**
+   * \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 );
 
 };