src/SMESH_I/SMESH_PreMeshInfo.hxx

   1 // Copyright (C) 2007-2021  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, or (at your option) any later version.
  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 // File      : SMESH_PreMeshInfo.hxx
  23 // Created   : Fri Feb 10 13:25:02 2012
  24 // Author    : Edward AGAPOV (eap)
  25
  26
  27 #ifndef __SMESH_PreMeshInfo_HXX__
  28 #define __SMESH_PreMeshInfo_HXX__
  29
  30 #include "SMDS_MeshInfo.hxx"
  31 #include <SALOMEconfig.h>
  32 #include CORBA_SERVER_HEADER(SMESH_Mesh)
  33 #include CORBA_SERVER_HEADER(SALOMEDS)
  34
  35 #include <TopAbs_ShapeEnum.hxx>
  36 #include <TColStd_MapOfAsciiString.hxx>
  37
  38 class DriverMED_R_SMESHDS_Mesh;
  39 class HDFfile;
  40 class HDFgroup;
  41 class SMESH_Mesh_i;
  42
  43 /*!
  44  * \brief Class loading and holding information of a mesh object (mesh, group, submesh)
  45  *        not yet loaded from HDF file of study.
  46  *
  47  * Usage scenario:
  48  * - SMESH_PreMeshInfo::LoadFromFile() // reads info of all objects
  49  * - if ( myPreInfo ) myPreInfo->NbElements() // access to info by objects
  50  * - myPreInfo->FullLoadFromFile() // reads all mesh data and resets myPreInfo=NULL
  51  */
  52
  53 class SMESH_PreMeshInfo : public SMDS_MeshInfo
  54 {
  55 public:
  56   // fills SMESH_PreMeshInfo* field of all objects of mesh
  57   static void LoadFromFile( SMESH_Mesh_i*      mesh,
  58                             const int          meshID,
  59                             const std::string& medFile,
  60                             const std::string& hdfFile,
  61                             const bool         toRemoveFiles);
  62
  63   // saves SMESH_PreMeshInfo to the study file
  64   static void SaveToFile( SMESH_Mesh_i* mesh,
  65                           const int     meshID,
  66                           HDFfile*      hdfFile);
  67
  68   // remove all SMESH_PreMeshInfo fields from mesh and its child objects w/o data loading
  69   static void ForgetAllData( SMESH_Mesh_i* mesh );
  70
  71   // reads all data and remove all SMESH_PreMeshInfo fields from objects
  72   void FullLoadFromFile() const;
  73
  74   // remove all SMESH_PreMeshInfo fields from objects w/o data loading
  75   void ForgetAllData() const;
  76
  77   // calls either FullLoadFromFile() or ForgetAllData() depending on preferences;
  78   // is called on hypothesis modification
  79   void ForgetOrLoad() const;
  80
  81   // meshods of SMESH_IDSource interface
  82   SMESH::array_of_ElementType* GetTypes() const;
  83   SMESH::long_array*           GetMeshInfo() const;
  84   bool                         IsMeshInfoCorrect() const;
  85
  86   ~SMESH_PreMeshInfo();
  87
  88   // TEMPORARY method to remove study files on closing study;
  89   // RIGHT WAY: study files are remove automatically when meshes are destroyed
  90   static void RemoveStudyFiles_TMP_METHOD(SALOMEDS::SComponent_ptr smeshComp);
  91
  92 private:
  93
  94   // creation by LoadFromFile() only
  95   SMESH_PreMeshInfo(SMESH_Mesh_i*      mesh,
  96                     const int          meshID,
  97                     const std::string& medFile,
  98                     const std::string& hdfFile);
  99
 100   SMESH_PreMeshInfo* newInstance()
 101   { return new SMESH_PreMeshInfo( _mesh,_meshID,_medFileName,_hdfFileName ); }
 102
 103   // reading from the new study, for which SaveToFile() was called
 104   bool readPreInfoFromHDF();
 105   void hdf2meshInfo( const std::string&              dataSetName,
 106                      HDFgroup*                       infoHdfGroup,
 107                      const TColStd_MapOfAsciiString& allHdfNames);
 108
 109   // reading from the old study, for which SaveToFile() was not called
 110   bool readMeshInfo();
 111   void readGroupInfo();
 112   void readSubMeshInfo();
 113   SMDSAbs_EntityType getElemType( const TopAbs_ShapeEnum shapeType,
 114                                   const int              nbElemsInSubMesh,
 115                                   bool&                  isKoType) const;
 116
 117   void readSubMeshes(DriverMED_R_SMESHDS_Mesh* reader) const;
 118
 119   // general data
 120   std::string   _medFileName, _hdfFileName;
 121   bool          _toRemoveFiles;
 122   int           _meshID;
 123   SMESH_Mesh_i* _mesh;
 124   bool          _isInfoOk;
 125
 126   int _elemCounter; /* used as a counter while mesh info reading and
 127                        as a signal that mesh info is incorrect after reading
 128                      */
 129 };
 130
 131 #endif