Salome HOME
Merge remote branch 'origin/V8_5_asterstudy'
[modules/smesh.git] / src / Driver / Driver_Mesh.h
1 // Copyright (C) 2007-2016  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
32 #include <string>
33 #include <vector>
34
35 #ifdef WIN32
36  #if defined MESHDRIVER_EXPORTS || defined MeshDriver_EXPORTS
37   #define MESHDRIVER_EXPORT __declspec( dllexport )
38  #else
39   #define MESHDRIVER_EXPORT __declspec( dllimport )
40  #endif
41 #else
42  #define MESHDRIVER_EXPORT
43 #endif
44
45 class MESHDRIVER_EXPORT Driver_Mesh
46 {
47  public:
48   Driver_Mesh();
49   virtual ~Driver_Mesh(){}
50
51   enum Status {
52     DRS_OK,
53     DRS_EMPTY,          // a file contains no mesh with the given name
54     DRS_WARN_RENUMBER,  // a file has overlapped ranges of element numbers,
55                         // so the numbers from the file are ignored
56     DRS_WARN_SKIP_ELEM, // some elements were skipped due to incorrect file data
57     DRS_WARN_DESCENDING, // some elements were skipped due to descending connectivity
58     DRS_FAIL            // general failure (exception etc.)
59   };
60
61   void                SetMeshId(int theMeshId);
62   virtual void        SetFile(const std::string& theFileName);
63   virtual void        SetMeshName(const std::string& theMeshName);
64   virtual std::string GetMeshName() const;
65
66   virtual void        SetOption(const std::string& optionName,
67                                 const std::string& optionValue) {}
68
69   virtual Status Perform() = 0;
70
71   virtual SMESH_ComputeErrorPtr GetError();
72
73  protected:
74   std::string myFile;
75   std::string myMeshName;
76   int         myMeshId;
77
78   static std::string fixUTF8(const std::string & s );
79
80   Status addMessage(const std::string& msg, const bool isFatal=false);
81   std::vector< std::string > myErrorMessages;
82   Status                     myStatus;
83 };
84
85 #endif