src/TOOLSDS/SALOMEDS_Tool.hxx

   1 // Copyright (C) 2007-2011  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //  File      : SALOMEDS_Tool.hxx
  24 //  Created   : Mon Oct 21 16:24:50 2002
  25 //  Author    : Sergey RUIN
  26 //  Project   : SALOME
  27 //  Module    : SALOMEDS
  28 //
  29 #ifndef __SALOMEDS_Tool_H__
  30 #define __SALOMEDS_Tool_H__
  31
  32 #include <string>
  33 #include <list>
  34
  35
  36 // IDL headers
  37 #include "SALOMEconfig.h"
  38 #include CORBA_SERVER_HEADER(SALOMEDS)
  39
  40 #ifdef WIN32
  41 # if defined TOOLSDS_EXPORTS
  42 #  define TOOLSDS_EXPORT __declspec( dllexport )
  43 # else
  44 #  define TOOLSDS_EXPORT __declspec( dllimport )
  45 # endif
  46 #else
  47 # define TOOLSDS_EXPORT
  48 #endif
  49
  50 class TOOLSDS_EXPORT SALOMEDS_Tool
  51 {
  52 public:
  53
  54   // Returns the unique temporary directory, that is defined in SALOME_TMP_DIR if this variable is set
  55   // otherwise return /tmp/something/ for Unix or c:\something\ for WIN32
  56   static std::string GetTmpDir();
  57
  58
  59   // Removes files which are in <theDirectory>, the files for deletion are listed in <theFiles>
  60   // if <IsDirDeleted> is true <theDirectory> is also deleted if it is empty
  61   static void RemoveTemporaryFiles(const std::string& theDirectory,
  62                                    const SALOMEDS::ListOfFileNames& theFiles,
  63                                    const bool IsDirDeleted);
  64
  65   // Converts files listed in <theFiles> which are in <theFromDirectory> into a byte sequence TMPFile
  66   static SALOMEDS::TMPFile* PutFilesToStream(const std::string& theFromDirectory,
  67                                              const SALOMEDS::ListOfFileNames& theFiles,
  68                                              const int theNamesOnly = 0);
  69
  70   // Converts files listed in <theFiles> which will be named as pointed in the <theFileNames> into a byte sequence TMPFile
  71   static SALOMEDS::TMPFile* PutFilesToStream(const SALOMEDS::ListOfFileNames& theFiles,
  72                                              const SALOMEDS::ListOfFileNames& theFileNames);
  73
  74   // Converts a byte sequence <theStream> to files and places them in <theToDirectory>
  75   static SALOMEDS::ListOfFileNames_var PutStreamToFiles(const SALOMEDS::TMPFile& theStream,
  76                                                         const std::string& theToDirectory,
  77                                                         const int theNamesOnly = 0);
  78
  79   // Returns the name by the path
  80   // for an example: if thePath = "/tmp/aaa/doc1.hdf" the function returns "doc1"
  81   static std::string GetNameFromPath(const std::string& thePath);
  82
  83   // Returns the directory by the path
  84   // for an example: if thePath = "/tmp/aaa/doc1.hdf" the function returns "/tmp/aaa"
  85   static std::string GetDirFromPath(const std::string& thePath);
  86
  87   // Retrieves specified flaf from "AttributeFlags" attribute
  88   static bool GetFlag( const int             theFlag,
  89                        SALOMEDS::Study_var   theStudy,
  90                        SALOMEDS::SObject_var theObj );
  91
  92   // Sets/Unsets specified flaf from "AttributeFlags" attribute
  93   static bool SetFlag( const int           theFlag,
  94                        SALOMEDS::Study_var theStudy,
  95                        const std::string&  theEntry,
  96                        const bool          theValue );
  97
  98   // Get all children of object. If theObj is null all objects of study are returned
  99   static void GetAllChildren( SALOMEDS::Study_var               theStudy,
 100                               SALOMEDS::SObject_var             theObj,
 101                               std::list<SALOMEDS::SObject_var>& theList );
 102
 103 };
 104 #endif
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124