src/SMESH_I/SMESH_Mesh_i.hxx

   1 //  SMESH SMESH_I : idl implementation based on 'SMESH' unit's calsses
   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_Mesh_i.hxx
  25 //  Author : Paul RASCLE, EDF
  26 //  Module : SMESH
  27 //  $Header$
  28
  29 #ifndef _SMESH_MESH_I_HXX_
  30 #define _SMESH_MESH_I_HXX_
  31
  32 #include "SMESH.hxx"
  33
  34 #include <SALOMEconfig.h>
  35 #include CORBA_SERVER_HEADER(SMESH_Mesh)
  36 #include CORBA_SERVER_HEADER(SMESH_Group)
  37 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
  38 #include CORBA_CLIENT_HEADER(GEOM_Gen)
  39 #include CORBA_CLIENT_HEADER(MED)
  40
  41 #include "SMESH_Hypothesis.hxx"
  42 #include "SMESH_Mesh.hxx"
  43 //#include "SMESH_subMesh_i.hxx"
  44 #include "SMESH_subMesh.hxx"
  45
  46 #include "SALOME_GenericObj_i.hh"
  47
  48 class SMESH_Gen_i;
  49 class SMESH_GroupBase_i;
  50 class SMESH_subMesh_i;
  51
  52 #include <map>
  53
  54 class SMESH_I_EXPORT SMESH_Mesh_i:
  55   public virtual POA_SMESH::SMESH_Mesh,
  56   public virtual SALOME::GenericObj_i
  57 {
  58   SMESH_Mesh_i();
  59   SMESH_Mesh_i(const SMESH_Mesh_i&);
  60 public:
  61   SMESH_Mesh_i( PortableServer::POA_ptr thePOA,
  62                 SMESH_Gen_i*            myGen_i,
  63                 CORBA::Long             studyId );
  64
  65   virtual ~SMESH_Mesh_i();
  66
  67   // --- CORBA
  68   void SetShape( GEOM::GEOM_Object_ptr theShapeObject )
  69     throw (SALOME::SALOME_Exception);
  70
  71   CORBA::Boolean HasShapeToMesh()
  72     throw (SALOME::SALOME_Exception);
  73
  74   GEOM::GEOM_Object_ptr GetShapeToMesh()
  75     throw (SALOME::SALOME_Exception);
  76
  77   SMESH::Hypothesis_Status AddHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
  78                                          SMESH::SMESH_Hypothesis_ptr anHyp)
  79     throw (SALOME::SALOME_Exception);
  80
  81   SMESH::Hypothesis_Status RemoveHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
  82                                             SMESH::SMESH_Hypothesis_ptr anHyp)
  83     throw (SALOME::SALOME_Exception);
  84
  85   SMESH::ListOfHypothesis* GetHypothesisList(GEOM::GEOM_Object_ptr aSubShapeObject)
  86     throw (SALOME::SALOME_Exception);
  87
  88   SMESH::SMESH_subMesh_ptr GetSubMesh(GEOM::GEOM_Object_ptr aSubShapeObject, const char* theName)
  89     throw (SALOME::SALOME_Exception);
  90
  91   void RemoveSubMesh( SMESH::SMESH_subMesh_ptr theSubMesh )
  92     throw (SALOME::SALOME_Exception);
  93
  94   SMESH::SMESH_Group_ptr CreateGroup( SMESH::ElementType theElemType, const char* theName )
  95     throw (SALOME::SALOME_Exception);
  96
  97   SMESH::SMESH_GroupOnGeom_ptr CreateGroupFromGEOM(SMESH::ElementType    theElemType,
  98                                                    const char*           theName,
  99                                                    GEOM::GEOM_Object_ptr theGeomObj )
 100     throw (SALOME::SALOME_Exception);
 101
 102   void RemoveGroup( SMESH::SMESH_GroupBase_ptr theGroup )
 103     throw (SALOME::SALOME_Exception);
 104
 105   void RemoveGroupWithContents( SMESH::SMESH_GroupBase_ptr theGroup )
 106     throw (SALOME::SALOME_Exception);
 107
 108   SMESH::ListOfGroups* GetGroups()
 109     throw (SALOME::SALOME_Exception);
 110
 111   CORBA::Long NbGroups()
 112     throw (SALOME::SALOME_Exception);
 113
 114   SMESH::SMESH_Group_ptr UnionGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
 115                                       SMESH::SMESH_GroupBase_ptr theGroup2,
 116                                       const char* theName )
 117     throw (SALOME::SALOME_Exception);
 118
 119   SMESH::SMESH_Group_ptr IntersectGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
 120                                           SMESH::SMESH_GroupBase_ptr theGroup2,
 121                                           const char* theName )
 122     throw (SALOME::SALOME_Exception);
 123
 124   SMESH::SMESH_Group_ptr CutGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
 125                                     SMESH::SMESH_GroupBase_ptr theGroup2,
 126                                    const char* theName )
 127     throw (SALOME::SALOME_Exception);
 128
 129 //    SMESH::string_array* GetLog(CORBA::Boolean clearAfterGet)
 130 //      throw (SALOME::SALOME_Exception);
 131
 132   SMESH::log_array* GetLog(CORBA::Boolean clearAfterGet)
 133     throw (SALOME::SALOME_Exception);
 134
 135   SMESH::SMESH_MeshEditor_ptr GetMeshEditor();
 136
 137   SMESH::SMESH_MeshEditor_ptr GetMeshEditPreviewer();
 138
 139   void ClearLog()
 140     throw (SALOME::SALOME_Exception);
 141
 142   CORBA::Long GetId()
 143     throw (SALOME::SALOME_Exception);
 144
 145   CORBA::Long GetStudyId()
 146     throw (SALOME::SALOME_Exception);
 147
 148   // --- C++ interface
 149   void SetImpl(::SMESH_Mesh* impl);
 150   ::SMESH_Mesh& GetImpl();         // :: force no namespace here
 151
 152   SMESH_Gen_i* GetGen() { return _gen_i; }
 153
 154   int ImportUNVFile( const char* theFileName )
 155     throw (SALOME::SALOME_Exception);
 156
 157   int ImportSTLFile( const char* theFileName )
 158     throw (SALOME::SALOME_Exception);
 159
 160   /*!
 161    * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
 162    */
 163   SMESH::DriverMED_ReadStatus ImportMEDFile( const char* theFileName, const char* theMeshName )
 164     throw (SALOME::SALOME_Exception);
 165
 166   /*!
 167    *  Auto color
 168    */
 169   void SetAutoColor(CORBA::Boolean theAutoColor)
 170     throw (SALOME::SALOME_Exception);
 171
 172   CORBA::Boolean GetAutoColor()
 173     throw (SALOME::SALOME_Exception);
 174
 175   /*! Check group names for duplications.
 176    *  Consider maximum group name length stored in MED file.
 177    */
 178   CORBA::Boolean HasDuplicatedGroupNamesMED();
 179   /*!
 180    * Return string representation of a MED file version comprising nbDigits
 181    */
 182   char* GetVersionString(SMESH::MED_VERSION version, CORBA::Short nbDigits);
 183
 184   void ExportToMED( const char* file, CORBA::Boolean auto_groups, SMESH::MED_VERSION theVersion )
 185     throw (SALOME::SALOME_Exception);
 186   void ExportMED( const char* file, CORBA::Boolean auto_groups )
 187     throw (SALOME::SALOME_Exception);
 188
 189   void ExportDAT( const char* file )
 190     throw (SALOME::SALOME_Exception);
 191   void ExportUNV( const char* file )
 192     throw (SALOME::SALOME_Exception);
 193   void ExportSTL( const char* file, bool isascii )
 194     throw (SALOME::SALOME_Exception);
 195
 196   SALOME_MED::MESH_ptr GetMEDMesh()
 197     throw (SALOME::SALOME_Exception);
 198
 199   CORBA::Long NbNodes()
 200     throw (SALOME::SALOME_Exception);
 201
 202   CORBA::Long NbElements()
 203     throw (SALOME::SALOME_Exception);
 204
 205   CORBA::Long NbEdges()
 206     throw (SALOME::SALOME_Exception);
 207
 208   CORBA::Long NbEdgesOfOrder(SMESH::ElementOrder order)
 209     throw (SALOME::SALOME_Exception);
 210
 211   CORBA::Long NbFaces()
 212     throw (SALOME::SALOME_Exception);
 213
 214   CORBA::Long NbFacesOfOrder(SMESH::ElementOrder order)
 215     throw (SALOME::SALOME_Exception);
 216
 217   CORBA::Long NbTriangles()
 218     throw (SALOME::SALOME_Exception);
 219
 220   CORBA::Long NbTrianglesOfOrder(SMESH::ElementOrder order)
 221     throw (SALOME::SALOME_Exception);
 222
 223   CORBA::Long NbQuadrangles()
 224     throw (SALOME::SALOME_Exception);
 225
 226   CORBA::Long NbQuadranglesOfOrder(SMESH::ElementOrder order)
 227     throw (SALOME::SALOME_Exception);
 228
 229   CORBA::Long NbPolygons()
 230     throw (SALOME::SALOME_Exception);
 231
 232   CORBA::Long NbVolumes()
 233     throw (SALOME::SALOME_Exception);
 234
 235   CORBA::Long NbVolumesOfOrder(SMESH::ElementOrder order)
 236     throw (SALOME::SALOME_Exception);
 237
 238   CORBA::Long NbTetras()
 239     throw (SALOME::SALOME_Exception);
 240
 241   CORBA::Long NbTetrasOfOrder(SMESH::ElementOrder order)
 242     throw (SALOME::SALOME_Exception);
 243
 244   CORBA::Long NbHexas()
 245     throw (SALOME::SALOME_Exception);
 246
 247   CORBA::Long NbHexasOfOrder(SMESH::ElementOrder order)
 248     throw (SALOME::SALOME_Exception);
 249
 250   CORBA::Long NbPyramids()
 251     throw (SALOME::SALOME_Exception);
 252
 253   CORBA::Long NbPyramidsOfOrder(SMESH::ElementOrder order)
 254     throw (SALOME::SALOME_Exception);
 255
 256   CORBA::Long NbPrisms()
 257     throw (SALOME::SALOME_Exception);
 258
 259   CORBA::Long NbPrismsOfOrder(SMESH::ElementOrder order)
 260     throw (SALOME::SALOME_Exception);
 261
 262   CORBA::Long NbPolyhedrons()
 263     throw (SALOME::SALOME_Exception);
 264
 265   CORBA::Long NbSubMesh()
 266     throw (SALOME::SALOME_Exception);
 267
 268   SMESH::long_array* GetElementsId()
 269     throw (SALOME::SALOME_Exception);
 270
 271   SMESH::long_array* GetElementsByType( SMESH::ElementType theElemType )
 272     throw (SALOME::SALOME_Exception);
 273
 274   SMESH::long_array* GetNodesId()
 275     throw (SALOME::SALOME_Exception);
 276
 277   SMESH::ElementType GetElementType( CORBA::Long id, bool iselem )
 278     throw (SALOME::SALOME_Exception);
 279
 280   /*!
 281    * Returns ID of elements for given submesh
 282    */
 283   SMESH::long_array* GetSubMeshElementsId(CORBA::Long ShapeID)
 284     throw (SALOME::SALOME_Exception);
 285
 286   /*!
 287    * Returns ID of nodes for given submesh
 288    * If param all==true - returns all nodes, else -
 289    * returns only nodes on shapes.
 290    */
 291   SMESH::long_array* GetSubMeshNodesId(CORBA::Long ShapeID, CORBA::Boolean all)
 292     throw (SALOME::SALOME_Exception);
 293
 294   /*!
 295    * Returns type of elements for given submesh
 296    */
 297   SMESH::ElementType GetSubMeshElementType(CORBA::Long ShapeID)
 298     throw (SALOME::SALOME_Exception);
 299
 300   char* Dump();
 301
 302   // Internal methods not available through CORBA
 303   // They are called by corresponding interface methods
 304   SMESH_Hypothesis::Hypothesis_Status addHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
 305                                                     SMESH::SMESH_Hypothesis_ptr anHyp);
 306
 307   SMESH_Hypothesis::Hypothesis_Status removeHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
 308                                                        SMESH::SMESH_Hypothesis_ptr anHyp);
 309
 310   static SMESH::Hypothesis_Status
 311   ConvertHypothesisStatus (SMESH_Hypothesis::Hypothesis_Status theStatus);
 312
 313   //int importMEDFile( const char* theFileName, const char* theMeshName );
 314
 315   SMESH::SMESH_subMesh_ptr createSubMesh( GEOM::GEOM_Object_ptr theSubShapeObject );
 316
 317   void removeSubMesh(SMESH::SMESH_subMesh_ptr theSubMesh,
 318                      GEOM::GEOM_Object_ptr theSubShapeObject );
 319
 320   SMESH::SMESH_GroupBase_ptr createGroup(SMESH::ElementType  theElemType,
 321                                          const char*         theName,
 322                                          const TopoDS_Shape& theShape = TopoDS_Shape());
 323
 324   void removeGroup( const int theId );
 325
 326   SMESH::SMESH_subMesh_ptr getSubMesh(int shapeID);
 327   // return an existing subMesh object for the shapeID. shapeID == submeshID.
 328
 329   const map<int, SMESH::SMESH_GroupBase_ptr>& getGroups() { return _mapGroups; }
 330   // return an existing group object.
 331
 332   /*!
 333    * \brief Update hypotheses assigned to geom groups if the latter change
 334    *
 335    * NPAL16168: "geometrical group edition from a submesh don't modifiy mesh computation"
 336    */
 337   void CheckGeomGroupModif();
 338
 339   virtual SMESH::long_array* GetIDs();
 340
 341   CORBA::LongLong GetMeshPtr();
 342
 343   /*!
 344    * \brief Assure that all groups are published
 345    */
 346   void CreateGroupServants();
 347
 348   /*!
 349    * \brief Return groups cantained in _mapGroups by their IDs
 350    */
 351   SMESH::ListOfGroups* GetGroups(const std::list<int>& groupIDs) const;
 352
 353   /*!
 354    * Get XYZ coordinates of node as list of double
 355    * If there is not node for given ID - returns empty list
 356    */
 357   SMESH::double_array* GetNodeXYZ(CORBA::Long id);
 358
 359   /*!
 360    * For given node returns list of IDs of inverse elements
 361    * If there is not node for given ID - returns empty list
 362    */
 363   SMESH::long_array* GetNodeInverseElements(CORBA::Long id);
 364
 365   /*!
 366    * \brief Return position of a node on shape
 367    */
 368   SMESH::NodePosition* GetNodePosition(CORBA::Long NodeID);
 369
 370   /*!
 371    * If given element is node returns IDs of shape from position
 372    * If there is not node for given ID - returns -1
 373    */
 374   CORBA::Long GetShapeID(CORBA::Long id);
 375
 376   /*!
 377    * For given element returns ID of result shape after
 378    * ::FindShape() from SMESH_MeshEditor
 379    * If there is not element for given ID - returns -1
 380    */
 381   CORBA::Long GetShapeIDForElem(CORBA::Long id);
 382
 383   /*!
 384    * Returns number of nodes for given element
 385    * If there is not element for given ID - returns -1
 386    */
 387   CORBA::Long GetElemNbNodes(CORBA::Long id);
 388
 389   /*!
 390    * Returns IDs of nodes of given element
 391    */
 392   SMESH::long_array* GetElemNodes(CORBA::Long id);
 393
 394   /*!
 395    * Returns ID of node by given index for given element
 396    * If there is not element for given ID - returns -1
 397    * If there is not node for given index - returns -2
 398    */
 399   CORBA::Long GetElemNode(CORBA::Long id, CORBA::Long index);
 400
 401   /*!
 402    * Returns true if given node is medium node
 403    * in given quadratic element
 404    */
 405   CORBA::Boolean IsMediumNode(CORBA::Long ide, CORBA::Long idn);
 406
 407   /*!
 408    * Returns true if given node is medium node
 409    * in one of quadratic elements
 410    */
 411   CORBA::Boolean IsMediumNodeOfAnyElem(CORBA::Long idn,
 412                                        SMESH::ElementType theElemType);
 413
 414   /*!
 415    * Returns number of edges for given element
 416    */
 417   CORBA::Long ElemNbEdges(CORBA::Long id);
 418
 419   /*!
 420    * Returns number of faces for given element
 421    */
 422   CORBA::Long ElemNbFaces(CORBA::Long id);
 423
 424   /*!
 425    * Returns true if given element is polygon
 426    */
 427   CORBA::Boolean IsPoly(CORBA::Long id);
 428
 429   /*!
 430    * Returns true if given element is quadratic
 431    */
 432   CORBA::Boolean IsQuadratic(CORBA::Long id);
 433
 434   /*!
 435    * Returns bary center for given element
 436    */
 437   SMESH::double_array* BaryCenter(CORBA::Long id);
 438
 439
 440   map<int, SMESH_subMesh_i*> _mapSubMesh_i; //NRI
 441   map<int, ::SMESH_subMesh*> _mapSubMesh;   //NRI
 442
 443 private:
 444
 445   static int myIdGenerator;
 446   ::SMESH_Mesh* _impl;  // :: force no namespace here
 447   SMESH_Gen_i* _gen_i;
 448   int _id;          // id given by creator (unique within the creator instance)
 449   int _studyId;
 450   map<int, SMESH::SMESH_subMesh_ptr>    _mapSubMeshIor;
 451   map<int, SMESH::SMESH_GroupBase_ptr>  _mapGroups;
 452   map<int, SMESH::SMESH_Hypothesis_ptr> _mapHypo;
 453 };
 454
 455 #endif
 456