src/SMESH/SMESH_Gen.hxx

   1 //  SMESH SMESH : implementaion of SMESH idl descriptions
   2 //
   3 //  Copyright (C) 2003  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 //
  24 //  File   : SMESH_Gen.hxx
  25 //  Author : Paul RASCLE, EDF
  26 //  Module : SMESH
  27 //  $Header$
  28
  29 #ifndef _SMESH_GEN_HXX_
  30 #define _SMESH_GEN_HXX_
  31
  32 #include "SMESH_SMESH.hxx"
  33
  34 #include "Utils_SALOME_Exception.hxx"
  35
  36 #include "SMESH_Hypothesis.hxx"
  37 #include "SMESH_Algo.hxx"
  38 #include "SMESH_1D_Algo.hxx"
  39 #include "SMESH_2D_Algo.hxx"
  40 #include "SMESH_3D_Algo.hxx"
  41 #include "SMESH_Mesh.hxx"
  42
  43 #include "SMESHDS_Document.hxx"
  44
  45 #include <TopoDS_Shape.hxx>
  46
  47 #include <map>
  48
  49
  50 typedef struct studyContextStruct
  51 {
  52         std::map < int, SMESH_Hypothesis * >mapHypothesis;
  53           std::map < int, SMESH_Mesh * >mapMesh;
  54           SMESHDS_Document * myDocument;
  55 } StudyContextStruct;
  56
  57 class SMESH_EXPORT  SMESH_Gen
  58 {
  59  public:
  60   SMESH_Gen();
  61   ~SMESH_Gen();
  62
  63 //  SMESH_Hypothesis *CreateHypothesis(const char *anHyp, int studyId)
  64 //    throw(SALOME_Exception);
  65   SMESH_Mesh* CreateMesh(int theStudyId, bool theIsEmbeddedMode)
  66     throw(SALOME_Exception);
  67   bool Compute(::SMESH_Mesh & aMesh, const TopoDS_Shape & aShape);
  68
  69   bool CheckAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape);
  70   // notify on bad state of attached algos, return false
  71   // if Compute() would fail because of some algo bad state
  72
  73
  74   enum TAlgoStateErrorName { NONE=0,
  75                              MISSING_ALGO,
  76                              MISSING_HYPO,
  77                              NOT_CONFORM_MESH,
  78                              BAD_PARAM_VALUE };
  79   struct TAlgoStateError
  80   {
  81     TAlgoStateErrorName _name;
  82     const SMESH_Algo*   _algo;
  83     int                 _algoDim;
  84     bool                _isGlobalAlgo;
  85
  86     TAlgoStateError(): _algoDim(0),_algo(0),_name(NONE) {}
  87     void Set(TAlgoStateErrorName name, const SMESH_Algo* algo, bool isGlobal)
  88     { _name = name; _algo = algo; _algoDim = algo->GetDim(); _isGlobalAlgo = isGlobal; }
  89     void Set(TAlgoStateErrorName name, const int algoDim,      bool isGlobal)
  90     { _name = name; _algo = 0;    _algoDim = algoDim;        _isGlobalAlgo = isGlobal; }
  91   };
  92
  93   bool GetAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape,
  94                     std::list< SMESH_Gen::TAlgoStateError > & theErrors);
  95   // notify on bad state of attached algos, return false
  96   // if Compute() would fail because of some algo bad state
  97   // theErrors list contains problems description
  98
  99
 100   StudyContextStruct *GetStudyContext(int studyId);
 101
 102   static int GetShapeDim(const TopAbs_ShapeEnum & aShapeType);
 103   static int GetShapeDim(const TopoDS_Shape & aShape)
 104   { return GetShapeDim( aShape.ShapeType() ); }
 105   SMESH_Algo* GetAlgo(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape);
 106   static bool IsGlobalHypothesis(const SMESH_Hypothesis* theHyp, SMESH_Mesh& aMesh);
 107
 108   // inherited methods from SALOMEDS::Driver
 109
 110   void Save(int studyId, const char *aUrlOfFile);
 111   void Load(int studyId, const char *aUrlOfFile);
 112   void Close(int studyId);
 113   const char *ComponentDataType();
 114
 115   const char *IORToLocalPersistentID(const char *IORString, bool & IsAFile);
 116   const char *LocalPersistentIDToIOR(const char *aLocalPersistentID);
 117
 118   int GetANewId();
 119
 120   std::map < int, SMESH_Algo * >_mapAlgo;
 121   std::map < int, SMESH_1D_Algo * >_map1D_Algo;
 122   std::map < int, SMESH_2D_Algo * >_map2D_Algo;
 123   std::map < int, SMESH_3D_Algo * >_map3D_Algo;
 124
 125  private:
 126
 127   int _localId;                         // unique Id of created objects, within SMESH_Gen entity
 128   std::map < int, StudyContextStruct * >_mapStudyContext;
 129
 130   // hypotheses managing
 131   int _hypId;
 132 };
 133
 134 #endif