Version: 9.12.0
Driver_Mesh.h
Go to the documentation of this file.
1 // Copyright (C) 2007-2023 CEA, EDF, 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 
23 // SMESH Driver : implementation of driver for reading and writing
24 // File : Mesh_Reader.h
25 // Module : SMESH
26 //
27 #ifndef _INCLUDE_DRIVER_MESH
28 #define _INCLUDE_DRIVER_MESH
29 
30 #include "SMESH_ComputeError.hxx"
31 #include "SMDS_Mesh.hxx"
32 
33 #include <string>
34 #include <vector>
35 #include <smIdType.hxx>
36 
37 #ifdef WIN32
38  #if defined MESHDRIVER_EXPORTS || defined MeshDriver_EXPORTS
39  #define MESHDRIVER_EXPORT __declspec( dllexport )
40  #else
41  #define MESHDRIVER_EXPORT __declspec( dllimport )
42  #endif
43 #else
44  #define MESHDRIVER_EXPORT
45 #endif
46 
48 {
49  public:
50  Driver_Mesh();
51  virtual ~Driver_Mesh(){}
52 
53  enum Status {
55  DRS_EMPTY, // a file contains no mesh with the given name
56  DRS_WARN_RENUMBER, // a file has overlapped ranges of element numbers,
57  // so the numbers from the file are ignored
58  DRS_WARN_SKIP_ELEM, // some elements were skipped due to incorrect file data
59  DRS_WARN_DESCENDING, // some elements were skipped due to descending connectivity
60  DRS_FAIL, // general failure (exception etc.)
61  DRS_TOO_LARGE_MESH // mesh is too large for export
62  };
63 
64  void SetMeshId(int theMeshId);
65  virtual void SetFile(const std::string& theFileName);
66  virtual void SetMeshName(const std::string& theMeshName);
67  virtual std::string GetMeshName() const;
68 
69  virtual void SetOption(const std::string& /*optionName*/,
70  const std::string& /*optionValue*/) {}
71 
72  virtual Status Perform() = 0;
73 
74  virtual SMESH_ComputeErrorPtr GetError();
75 
76  // check if a mesh is too large to export it using IDTYPE;
77  // check either max ID or number of elements
78  template< typename IDTYPE >
79  static bool IsMeshTooLarge( const SMDS_Mesh* mesh, bool checkIDs )
80  {
81  if ( sizeof( IDTYPE ) < sizeof( smIdType ))
82  {
83  const smIdType maxNB = ToSmIdType( std::numeric_limits< IDTYPE >::max() );
84  return (( checkIDs ? mesh->MaxNodeID() : mesh->NbNodes() ) > maxNB ||
85  ( checkIDs ? mesh->MaxElementID() : mesh->NbElements() > maxNB ));
86  }
87  return false;
88  }
89 
90  protected:
91  std::string myFile;
92  std::string myMeshName;
93  int myMeshId;
94 
95  static std::string fixUTF8(const std::string & s );
96 
97  Status addMessage(const std::string& msg, const bool isFatal=false);
98  std::vector< std::string > myErrorMessages;
100 };
101 
102 #endif
#define MESHDRIVER_EXPORT
Definition: Driver_Mesh.h:44
boost::shared_ptr< SMESH_ComputeError > SMESH_ComputeErrorPtr
Definition: SMESH_ComputeError.hxx:36
Definition: Driver_Mesh.h:48
virtual ~Driver_Mesh()
Definition: Driver_Mesh.h:51
int myMeshId
Definition: Driver_Mesh.h:93
Status myStatus
Definition: Driver_Mesh.h:99
virtual Status Perform()=0
Status
Definition: Driver_Mesh.h:53
@ DRS_EMPTY
Definition: Driver_Mesh.h:55
@ DRS_FAIL
Definition: Driver_Mesh.h:60
@ DRS_WARN_DESCENDING
Definition: Driver_Mesh.h:59
@ DRS_OK
Definition: Driver_Mesh.h:54
@ DRS_WARN_RENUMBER
Definition: Driver_Mesh.h:56
@ DRS_WARN_SKIP_ELEM
Definition: Driver_Mesh.h:58
std::string myFile
Definition: Driver_Mesh.h:91
virtual void SetOption(const std::string &, const std::string &)
Definition: Driver_Mesh.h:69
static bool IsMeshTooLarge(const SMDS_Mesh *mesh, bool checkIDs)
Definition: Driver_Mesh.h:79
std::string myMeshName
Definition: Driver_Mesh.h:92
std::vector< std::string > myErrorMessages
Definition: Driver_Mesh.h:98
Definition: SMDS_Mesh.hxx:53
virtual smIdType MaxElementID() const
Definition: SMDS_Mesh.cxx:2035
virtual smIdType NbElements() const
Return the number of elements.
Definition: SMDS_Mesh.cxx:1502
virtual smIdType NbNodes() const
Return the number of nodes.
Definition: SMDS_Mesh.cxx:1494
virtual smIdType MaxNodeID() const
Definition: SMDS_Mesh.cxx:2015