Salome HOME
Move color tags to the base geometrical object class.
[modules/hydro.git] / src / HYDROData / HYDROData_Tool.h
index 85824d6ef10f7cf5bec3358bf7b0ccfc0e0e8f62..5b550ca2b5bf502c51fc83b9693ea6136b858183 100644 (file)
@@ -2,15 +2,18 @@
 #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 QStringList;
-class Handle_HYDROData_Document;
+class Handle(HYDROData_Document);
 
-class HYDROData_Tool {
+class HYDRODATA_EXPORT HYDROData_Tool {
 
 public:
 
@@ -22,7 +25,47 @@ public:
    * Enables "MustBeUpdated" flag for Images that are depended on "MustBeUpdated" images.
    * \param theDoc document where this operation is performed
    */
-  static void                           SetMustBeUpdatedImages( Handle_HYDROData_Document theDoc );
+  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
+   * \return generated name
+   */
+  static QString                        GenerateObjectName( const Handle(HYDROData_Document)& theDoc,
+                                                            const QString&                    thePrefix,
+                                                            const QStringList&                theUsedNames = QStringList() );
+
+  /**
+   * \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 );
 
 };