Salome HOME
a1af52641f04b2e6e9fe6e4a9ce8df17b7b7651d
[modules/smesh.git] / src / Driver / Driver_Mesh.h
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
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
36 #ifdef WIN32
37  #if defined MESHDRIVER_EXPORTS || defined MeshDriver_EXPORTS
38   #define MESHDRIVER_EXPORT __declspec( dllexport )
39  #else
40   #define MESHDRIVER_EXPORT __declspec( dllimport )
41  #endif
42 #else
43  #define MESHDRIVER_EXPORT
44 #endif
45
46 class MESHDRIVER_EXPORT Driver_Mesh
47 {
48  public:
49   Driver_Mesh();
50   virtual ~Driver_Mesh(){}
51
52   enum Status {
53     DRS_OK,
54     DRS_EMPTY,           // a file contains no mesh with the given name
55     DRS_WARN_RENUMBER,   // a file has overlapped ranges of element numbers,
56                          // so the numbers from the file are ignored
57     DRS_WARN_SKIP_ELEM,  // some elements were skipped due to incorrect file data
58     DRS_WARN_DESCENDING, // some elements were skipped due to descending connectivity
59     DRS_FAIL,            // general failure (exception etc.)
60     DRS_TOO_LARGE_MESH   // mesh is too large for export
61   };
62
63   void                SetMeshId(int theMeshId);
64   virtual void        SetFile(const std::string& theFileName);
65   virtual void        SetMeshName(const std::string& theMeshName);
66   virtual std::string GetMeshName() const;
67
68   virtual void        SetOption(const std::string& /*optionName*/,
69                                 const std::string& /*optionValue*/) {}
70
71   virtual Status Perform() = 0;
72
73   virtual SMESH_ComputeErrorPtr GetError();
74
75   //virtual bool CanExportMesh() const { return false; } //= 0;
76
77   // check if a mesh is too large to export it using IDTYPE;
78   // check either max ID or number of elements
79   template< typename IDTYPE >
80     static bool IsMeshTooLarge( const SMDS_Mesh* mesh, bool checkIDs )
81   {
82     if ( sizeof( IDTYPE ) < sizeof( smIdType ))
83     {
84       const smIdType maxNB = std::numeric_limits< IDTYPE >::max();
85       return (( checkIDs ? mesh->MaxNodeID()    : mesh->NbNodes() )  > maxNB ||
86               ( checkIDs ? mesh->MaxElementID() : mesh->NbElements() > maxNB ));
87     }
88     return false;
89   }
90
91  protected:
92   std::string myFile;
93   std::string myMeshName;
94   int         myMeshId;
95
96   static std::string fixUTF8(const std::string & s );
97
98   Status addMessage(const std::string& msg, const bool isFatal=false);
99   std::vector< std::string > myErrorMessages;
100   Status                     myStatus;
101 };
102
103 #endif