Salome HOME
First stable version after merging with V3_2_2
[modules/kernel.git] / src / TOOLSDS / SALOMEDS_Tool.hxx
index c5f8e2260fecd64e31abc38b000cc4c40d2cf460..0c57ace2e93ba183939dda374aaa6b6c6368a7e0 100644 (file)
+// Copyright (C) 2005  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.
+// 
+// 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
+//
 //  File      : SALOMEDS_Tool.hxx
 //  Created   : Mon Oct 21 16:24:50 2002
 //  Author    : Sergey RUIN
 
 //  Project   : SALOME
 //  Module    : SALOMEDS
-//  Copyright : Open CASCADE
-
 
 #ifndef __SALOMEDS_Tool_H__
 #define __SALOMEDS_Tool_H__
 
+#include <string>
+#include <list> 
 
 
 // IDL headers
-#include <SALOMEDS.hh> 
+#include "SALOMEconfig.h"
+#include CORBA_SERVER_HEADER(SALOMEDS)
+
+#ifdef WNT
+ #if defined TOOLSDS_EXPORTS
+  #if defined WIN32
+   #define TOOLSDS_EXPORT __declspec( dllexport )
+  #else
+   #define TOOLSDS_EXPORT
+  #endif
+ #else
+  #if defined WIN32
+   #define TOOLSDS_EXPORT __declspec( dllimport )
+  #else
+   #define TOOLSDS_EXPORT
+  #endif
+ #endif
+#else
+ #define TOOLSDS_EXPORT
+#endif
 
-class SALOMEDS_Tool                                
+class TOOLSDS_EXPORT SALOMEDS_Tool                                
 {
 public:
  
   // Returns the unique temporary directory, that is defined in SALOME_TMP_DIR if this variable is set
   // otherwise return /tmp/something/ for Unix or c:\something\ for WNT
-  static char* GetTmpDir();
+  static std::string GetTmpDir();
 
  
   // Removes files which are in <theDirectory>, the files for deletion are listed in <theFiles>
   // if <IsDirDeleted> is true <theDirectory> is also deleted if it is empty
-  static void RemoveTemporaryFiles(const char* theDirectory,
+  static void RemoveTemporaryFiles(const std::string& theDirectory,
                                   const SALOMEDS::ListOfFileNames& theFiles,
                                   const bool IsDirDeleted);
 
   // Converts files listed in <theFiles> which are in <theFromDirectory> into a byte sequence TMPFile
-  static SALOMEDS::TMPFile* PutFilesToStream(const char* theFromDirectory, 
+  static SALOMEDS::TMPFile* PutFilesToStream(const std::string& theFromDirectory, 
                                             const SALOMEDS::ListOfFileNames& theFiles,
                                             const int theNamesOnly = 0);
 
+  // Converts files listed in <theFiles> which will be named as pointed in the <theFileNames> into a byte sequence TMPFile
+  static SALOMEDS::TMPFile* PutFilesToStream(const SALOMEDS::ListOfFileNames& theFiles,
+                                            const SALOMEDS::ListOfFileNames& theFileNames);
+
   // Converts a byte sequence <theStream> to files and places them in <theToDirectory>
-  static SALOMEDS::ListOfFileNames* PutStreamToFiles(const SALOMEDS::TMPFile& theStream,
-                                                     const char* theToDirectory,
-                                                    const int theNamesOnly = 0);
+  static SALOMEDS::ListOfFileNames_var PutStreamToFiles(const SALOMEDS::TMPFile& theStream,
+                                                       const std::string& theToDirectory,
+                                                       const int theNamesOnly = 0);
 
   // Returns the name by the path
   // for an example: if thePath = "/tmp/aaa/doc1.hdf" the function returns "doc1"
-  static char* GetNameFromPath(const char* thePath);
+  static std::string GetNameFromPath(const std::string& thePath);
 
   // Returns the directory by the path
   // for an example: if thePath = "/tmp/aaa/doc1.hdf" the function returns "/tmp/aaa"
-  static char* GetDirFromPath(const char* thePath);
+  static std::string GetDirFromPath(const std::string& thePath);
+
+  // Retrieves specified flaf from "AttributeFlags" attribute
+  static bool GetFlag( const int             theFlag,
+                       SALOMEDS::Study_var   theStudy,
+                       SALOMEDS::SObject_var theObj );
+
+  // Sets/Unsets specified flaf from "AttributeFlags" attribute
+  static bool SetFlag( const int           theFlag,
+                       SALOMEDS::Study_var theStudy,
+                       const std::string&  theEntry,
+                       const bool          theValue );
+
+  // Get all children of object. If theObj is null all objects of study are returned
+  static void GetAllChildren( SALOMEDS::Study_var               theStudy,
+                              SALOMEDS::SObject_var             theObj,
+                              std::list<SALOMEDS::SObject_var>& theList );
 
 };
 #endif
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+