idl/SMESH_Mesh.idl

   1 //  Copyright (C) 2007-2011  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.
  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 //  File   : SMESH_Mesh.idl
  24 //  Author : Paul RASCLE, EDF
  25 //
  26 #ifndef _SMESH_MESH_IDL_
  27 #define _SMESH_MESH_IDL_
  28
  29 #include "SALOME_Exception.idl"
  30 #include "SALOME_GenericObj.idl"
  31 #include "GEOM_Gen.idl"
  32 #include "MED.idl"
  33
  34 module SMESH
  35 {
  36   interface SMESH_Hypothesis;
  37   typedef sequence<SMESH_Hypothesis> ListOfHypothesis;
  38   interface SMESH_GroupBase;
  39   typedef sequence<SMESH_GroupBase> ListOfGroups;
  40   interface SMESH_IDSource;
  41   typedef sequence<SMESH_IDSource> ListOfIDSources;
  42
  43   typedef sequence<double    > double_array ;
  44   typedef sequence<long      > long_array ;
  45   typedef sequence<string    > string_array ;
  46   typedef sequence<long_array> array_of_long_array ;
  47
  48   enum log_command
  49     {
  50       ADD_NODE,
  51       ADD_EDGE,
  52       ADD_TRIANGLE,
  53       ADD_QUADRANGLE,
  54       ADD_POLYGON,
  55       ADD_TETRAHEDRON,
  56       ADD_PYRAMID,
  57       ADD_PRISM,
  58       ADD_HEXAHEDRON,
  59       ADD_POLYHEDRON,
  60       REMOVE_NODE,
  61       REMOVE_ELEMENT,
  62       MOVE_NODE,
  63       CHANGE_ELEMENT_NODES,
  64       CHANGE_POLYHEDRON_NODES,
  65       RENUMBER,
  66       CLEAR_MESH,
  67       ADD_QUADEDGE,
  68       ADD_QUADTRIANGLE,
  69       ADD_QUADQUADRANGLE,
  70       ADD_QUADTETRAHEDRON,
  71       ADD_QUADPYRAMID,
  72       ADD_QUADPENTAHEDRON,
  73       ADD_QUADHEXAHEDRON,
  74       ADD_ELEM0D
  75     };
  76
  77   struct log_block
  78   {
  79     long commandType;
  80     long number;
  81     double_array coords;
  82     long_array indexes;
  83   };
  84
  85   struct PointStruct { double x;
  86                        double y;
  87                        double z; } ;
  88
  89   typedef sequence<PointStruct> nodes_array;
  90
  91   struct DirStruct   { PointStruct PS ; } ;          // analog to Occ Direction
  92
  93   struct AxisStruct  { double x;
  94                        double y;
  95                        double z;
  96                        double vx;
  97                        double vy;
  98                        double vz; } ;
  99
 100   /*!
 101    * Node location on a shape
 102    */
 103   struct NodePosition {
 104     long             shapeID;
 105     GEOM::shape_type shapeType;
 106     double_array     params; // [U] on EDGE, [U,V] on FACE, [] on the rest shapes
 107   };
 108
 109   /*!
 110    * Enumeration for element type, like in SMDS
 111    */
 112   enum ElementType
 113   {
 114     ALL,
 115     NODE,
 116     EDGE,
 117     FACE,
 118     VOLUME,
 119     ELEM0D
 120   };
 121   typedef sequence<ElementType> array_of_ElementType ;
 122
 123   /*!
 124    * Enumeration for element geometry type, like in SMDS
 125    */
 126   enum GeometryType
 127   {
 128     Geom_POINT,
 129     Geom_EDGE,
 130     Geom_TRIANGLE,
 131     Geom_QUADRANGLE,
 132     Geom_POLYGON,
 133     Geom_TETRA,
 134     Geom_PYRAMID,
 135     Geom_HEXA,
 136     Geom_PENTA,
 137     Geom_POLYHEDRA
 138   };
 139
 140   /*!
 141    * ElementOrder points out entities of what order are requested
 142    */
 143   enum ElementOrder {
 144     ORDER_ANY,          /*! entities of any order */
 145     ORDER_LINEAR,       /*! entities of 1st order */
 146     ORDER_QUADRATIC     /*! entities of 2nd order */
 147   };
 148
 149
 150   /*!
 151    * Enumeration of entity type uses in mesh info array,
 152    *  and should be synchronised with enum in SMDS
 153    */
 154   enum EntityType
 155   {
 156     Entity_Node,
 157     Entity_0D,
 158     Entity_Edge,
 159     Entity_Quad_Edge,
 160     Entity_Triangle,
 161     Entity_Quad_Triangle,
 162     Entity_Quadrangle,
 163     Entity_Quad_Quadrangle,
 164     Entity_Polygon,
 165     Entity_Quad_Polygon,
 166     Entity_Tetra,
 167     Entity_Quad_Tetra,
 168     Entity_Pyramid,
 169     Entity_Quad_Pyramid,
 170     Entity_Hexa,
 171     Entity_Quad_Hexa,
 172     Entity_Penta,
 173     Entity_Quad_Penta,
 174     Entity_Polyhedra,
 175     Entity_Quad_Polyhedra,
 176     Entity_Last
 177   };
 178
 179
 180   /*!
 181    * Enumeration for hypothesis status (used by AddHypothesis() and RemoveHypothesis() methods)
 182    */
 183   enum Hypothesis_Status // in the order of severity
 184   {
 185     HYP_OK,
 186     HYP_MISSING,      // algo misses a hypothesis
 187     HYP_CONCURENT,    // several applicable hypotheses
 188     HYP_BAD_PARAMETER,// hypothesis has a bad parameter value
 189     HYP_HIDDEN_ALGO,  // an algo is hidden by an upper dim algo generating all-dim elements
 190     HYP_HIDING_ALGO,  // an algo hides lower dim algos by generating all-dim elements
 191     HYP_UNKNOWN_FATAL,//  --- all statuses below should be considered as fatal
 192                       //      for Add/RemoveHypothesis operations
 193     HYP_INCOMPATIBLE, // hypothesis does not fit algo
 194     HYP_NOTCONFORM,   // not conform mesh is produced appling a hypothesis
 195     HYP_ALREADY_EXIST,// such hypothesis already exist
 196     HYP_BAD_DIM,      // bad dimension
 197     HYP_BAD_SUBSHAPE, // shape is neither the main one, nor its subshape, nor a group
 198     HYP_BAD_GEOMETRY, // geometry mismatches algorithm's expectation
 199     HYP_NEED_SHAPE    // algorithm can work on shape only
 200   };
 201
 202   /*!
 203    * Enumeration for DriverMED read status (used by ImportMEDFile() method)
 204    */
 205   enum DriverMED_ReadStatus // in the order of severity
 206   {
 207     DRS_OK,
 208     DRS_EMPTY,          // a MED file contains no mesh with the given name
 209     DRS_WARN_RENUMBER,  // a MED file has overlapped ranges of element numbers,
 210                         // so the numbers from the file are ignored
 211     DRS_WARN_SKIP_ELEM, // some elements were skipped due to incorrect file data
 212     DRS_FAIL            // general failure (exception etc.)
 213   };
 214
 215   /*!
 216    * Enumeration for DriverMED (used by Perform() method)
 217    */
 218   enum MED_VERSION // in the order of severity
 219   {
 220     MED_V2_1,
 221     MED_V2_2
 222   };
 223
 224   typedef sequence<log_block> log_array;
 225
 226
 227   /*!
 228    * Auxilary flags for advanced extrusion.
 229    * BOUNDARY: create or not boundary for result of extrusion
 230    * SEW:      try to use existing nodes or create new nodes in any case
 231    */
 232   const long EXTRUSION_FLAG_BOUNDARY = 1;
 233   const long EXTRUSION_FLAG_SEW = 2;
 234
 235   /*!
 236    * Structure used in mesh edit preview data (MeshPreviewStruct)
 237    */
 238   struct ElementSubType { ElementType SMDS_ElementType;
 239                           boolean     isPoly;
 240                           long        nbNodesInElement; };
 241
 242   typedef sequence<ElementSubType> types_array;
 243
 244   /*!
 245    * Structure containing mesh edit preview data
 246    */
 247   struct MeshPreviewStruct { nodes_array nodesXYZ;
 248                              long_array  elementConnectivities;
 249                              types_array elementTypes; };
 250
 251   interface SMESH_IDSource
 252   {
 253     /*!
 254      * Returns a sequence of all element IDs
 255      */
 256     long_array GetIDs();
 257
 258     /*!
 259      * Returns statistic of mesh elements
 260      * Result array of number enityties
 261      */
 262     long_array GetMeshInfo();
 263
 264     /*!
 265      * Returns types of elements it contains
 266      */
 267     array_of_ElementType GetTypes();
 268   };
 269
 270   interface SMESH_Group;
 271   interface SMESH_GroupOnGeom;
 272   interface SMESH_subMesh;
 273   interface SMESH_MeshEditor;
 274
 275   typedef sequence<SMESH_subMesh>     submesh_array;
 276   typedef sequence<submesh_array>     submesh_array_array;
 277
 278   interface SMESH_Mesh : SALOME::GenericObj, SMESH_IDSource
 279   {
 280     /*!
 281      * Return true if there is a geometry to be meshed
 282      */
 283     boolean HasShapeToMesh()
 284       raises (SALOME::SALOME_Exception);
 285
 286     /*!
 287      * Get geom shape to mesh. A result sould not be nil. Use HasShapeToMesh()
 288      * to know if a returned shape
 289      */
 290     GEOM::GEOM_Object GetShapeToMesh()
 291       raises (SALOME::SALOME_Exception);
 292
 293     /*!
 294      * Remove all nodes and elements
 295      */
 296     void Clear()
 297       raises (SALOME::SALOME_Exception);
 298
 299     /*!
 300      * Remove all nodes and elements of submesh
 301      */
 302     void ClearSubMesh(in long ShapeID)
 303       raises (SALOME::SALOME_Exception);
 304
 305     /*!
 306      * Get the subMesh object associated to a subShape. The subMesh object
 307      * gives access to nodes and elements IDs.
 308      * SubMesh will be used instead of SubShape in a next idl version to
 309      * adress a specific subMesh...
 310      */
 311     SMESH_subMesh GetSubMesh(in GEOM::GEOM_Object aSubObject, in string name)
 312       raises (SALOME::SALOME_Exception);
 313
 314     /*!
 315      * Remove a submesh
 316      */
 317     void RemoveSubMesh(in SMESH_subMesh aSubMesh)
 318       raises (SALOME::SALOME_Exception);
 319
 320
 321     /*!
 322      * Create a group
 323      */
 324     SMESH_Group CreateGroup( in ElementType elem_type,
 325                              in string name )
 326       raises (SALOME::SALOME_Exception);
 327
 328     /*!
 329      * Create a group from geometry group
 330      */
 331     SMESH_GroupOnGeom CreateGroupFromGEOM( in ElementType elem_type,
 332                                           in string name,
 333                                           in GEOM::GEOM_Object theGeomObject )
 334       raises (SALOME::SALOME_Exception);
 335
 336     /*!
 337      * Remove a group
 338      */
 339     void RemoveGroup(in SMESH_GroupBase aGroup)
 340       raises (SALOME::SALOME_Exception);
 341
 342     /*!
 343      *  Remove group with its contents
 344      */
 345     void RemoveGroupWithContents( in SMESH_GroupBase aGroup )
 346       raises (SALOME::SALOME_Exception);
 347
 348     /*!
 349      *  Get the list of groups existing in the mesh
 350      */
 351     ListOfGroups GetGroups()
 352       raises (SALOME::SALOME_Exception);
 353
 354     /*!
 355      *  Get number of groups existing in the mesh
 356      */
 357     long NbGroups()
 358       raises (SALOME::SALOME_Exception);
 359
 360     /*!
 361      * Union of two groups
 362      *    New group is created. All mesh elements that are
 363      *    present in initial groups are added to the new one
 364      */
 365     SMESH_Group UnionGroups (in SMESH_GroupBase aGroup1,
 366                              in SMESH_GroupBase aGroup2,
 367                              in string          name )
 368       raises (SALOME::SALOME_Exception);
 369
 370     /*!
 371      * Union of list of groups
 372      * New group is created. All mesh elements that are
 373      * present in initial groups are added to the new one
 374      */
 375     SMESH_Group UnionListOfGroups (in ListOfGroups aListOfGroups,
 376                                    in string       name )
 377       raises (SALOME::SALOME_Exception);
 378
 379     /*!
 380      *  Intersection of two groups
 381      *  New group is created. All mesh elements that are
 382      *  present in both initial groups are added to the new one.
 383      */
 384     SMESH_Group IntersectGroups (in SMESH_GroupBase aGroup1,
 385                                  in SMESH_GroupBase aGroup2,
 386                                  in string          name )
 387       raises (SALOME::SALOME_Exception);
 388
 389     /*!
 390      *  Intersection of list of groups
 391      *  New group is created. All mesh elements that are
 392      *  present in all initial groups simultaneously are added to the new one.
 393      */
 394     SMESH_Group IntersectListOfGroups (in ListOfGroups aListOfGroups,
 395                                        in string       name)
 396       raises (SALOME::SALOME_Exception);
 397
 398     /*!
 399      *  Cut of two groups
 400      *  New group is created. All mesh elements that are present in
 401      *  main group but do not present in tool group are added to the new one
 402      */
 403     SMESH_Group CutGroups (in SMESH_GroupBase aMainGroup,
 404                            in SMESH_GroupBase aToolGroup,
 405                            in string          name )
 406       raises (SALOME::SALOME_Exception);
 407
 408     /*!
 409      *  Cut of lists of groups
 410      *  New group is created. All mesh elements that are present in
 411      *  main groups but do not present in tool groups are added to the new one
 412      */
 413     SMESH_Group CutListOfGroups (in ListOfGroups aMainGroups,
 414                                  in ListOfGroups aToolGroups,
 415                                  in string       name)
 416       raises (SALOME::SALOME_Exception);
 417
 418     /*!
 419      *  Create groups of entities from existing groups of superior dimensions
 420      *  New group is created. System
 421      *  1) extracts all nodes from each group,
 422      *  2) combines all elements of specified dimension laying on these nodes.
 423      */
 424     SMESH_Group CreateDimGroup( in ListOfGroups aListOfGroups,
 425                                 in ElementType  anElemType,
 426                                 in string       name )
 427       raises (SALOME::SALOME_Exception);
 428
 429     /*!
 430      * Convert group on geometry into standalone group
 431      */
 432     SMESH_Group ConvertToStandalone( in SMESH_GroupOnGeom theGeomGroup )
 433       raises (SALOME::SALOME_Exception);
 434
 435     /*!
 436      * Add hypothesis to the mesh, under a particular subShape
 437      * (or the main shape itself)
 438      * The Add method is only used to prepare the build of the mesh and store
 439      * the algorithms and associated parameters.
 440      * Actual job of mesh the shape is done by MESH_Gen.
 441      * @params
 442      * - aSubShape : subShape obtained by a shape explode in GEOM
 443      *   (or main shape)
 444      * - anHyp : hypothesis object
 445      * @return
 446      * - OK if the hypothesis is compatible with the subShape
 447      *   (and all previous hypothesis on the subShape)
 448      * - NOK if the hypothesis is not compatible with the subShape
 449      *   (or one previous hypothesis on the subShape)
 450      * raises exception if hypothesis has not been created
 451      */
 452     Hypothesis_Status AddHypothesis(in GEOM::GEOM_Object aSubObject,
 453                                     in SMESH_Hypothesis anHyp)
 454       raises (SALOME::SALOME_Exception);
 455 //     boolean AddHypothesis(in SMESH_subMesh aSubMesh, in SMESH_Hypothesis anHyp)
 456 //       raises (SALOME::SALOME_Exception);
 457
 458     /*!
 459      * Remove an hypothesis previouly added with AddHypothesis.
 460      */
 461     Hypothesis_Status RemoveHypothesis(in GEOM::GEOM_Object aSubObject,
 462                                        in SMESH_Hypothesis anHyp)
 463       raises (SALOME::SALOME_Exception);
 464 //     boolean RemoveHypothesis(in SMESH_subMesh aSubMesh,
 465 //                           in SMESH_Hypothesis anHyp)
 466 //       raises (SALOME::SALOME_Exception);
 467
 468     /*!
 469      * Get the list of hypothesis added on a subShape
 470      */
 471     ListOfHypothesis GetHypothesisList(in GEOM::GEOM_Object aSubObject)
 472       raises (SALOME::SALOME_Exception);
 473 //     ListOfHypothesis GetHypothesisList(in SMESH_subMesh aSubMesh)
 474 //       raises (SALOME::SALOME_Exception);
 475
 476     /*!
 477      * Get the log of nodes and elements added or removed since previous
 478      * clear of the log.
 479      * @params
 480      * - clearAfterGet : log is emptied after Get (safe if concurrents access)
 481      */
 482     //    string_array GetLog(in boolean clearAfterGet)
 483     //      raises (SALOME::SALOME_Exception);
 484     log_array GetLog(in boolean clearAfterGet)
 485       raises (SALOME::SALOME_Exception);
 486
 487     /*!
 488      * Clear the log of nodes and elements added or removed since previous
 489      * clear. Must be used immediately after GetLog if clearAfterGet is false.
 490      */
 491     void ClearLog()
 492       raises (SALOME::SALOME_Exception);
 493
 494     /*!
 495      * Toggle auto color mode on the object.
 496      * @params
 497      * - theAutoColor : flag which toggles auto color mode.
 498      */
 499     void SetAutoColor(in boolean theAutoColor)
 500       raises (SALOME::SALOME_Exception);
 501
 502     /*!
 503      * Get flag of object's auto color mode.
 504      */
 505     boolean GetAutoColor()
 506       raises (SALOME::SALOME_Exception);
 507
 508     /*!
 509      * Get the internal Id
 510      */
 511     long GetId();
 512
 513     /*!
 514      * Get the study Id
 515      */
 516     long GetStudyId();
 517
 518     /*!
 519      * Obtain instance of SMESH_MeshEditor
 520      */
 521     SMESH_MeshEditor GetMeshEditor()
 522       raises (SALOME::SALOME_Exception);
 523
 524     /*!
 525      * Return SMESH_MeshEditor that would not modify the mesh but
 526      * fill MeshPreviewStruct
 527      */
 528     SMESH_MeshEditor GetMeshEditPreviewer()
 529       raises (SALOME::SALOME_Exception);
 530
 531     /*!
 532      * Return true if the mesh has been edited since a total re-compute
 533      * and those modifications may prevent successful partial re-compute
 534      */
 535     boolean HasModificationsToDiscard()
 536       raises (SALOME::SALOME_Exception);
 537
 538     /*! Check group names for duplications.
 539      *  Consider maximum group name length stored in MED file.
 540      */
 541     boolean HasDuplicatedGroupNamesMED();
 542
 543     /*!
 544      * Export Mesh to different MED Formats
 545      * @params
 546      * - auto_groups : boolean parameter for creating/not creating
 547      *   the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
 548      *   the typical use is auto_groups=false.
 549      * - theVersion : define the version of format of MED file, that will be created
 550      * - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
 551      */
 552     void ExportToMEDX( in string file, in boolean auto_groups, in MED_VERSION theVersion, in boolean overwrite )
 553       raises (SALOME::SALOME_Exception);
 554
 555     /*!
 556      * Export Mesh to different MED Formats
 557      * Works, just the same as ExportToMEDX, with overwrite parameter equal to true.
 558      * The method is kept in order to support old functionality
 559      */
 560     void ExportToMED( in string file, in boolean auto_groups, in MED_VERSION theVersion )
 561       raises (SALOME::SALOME_Exception);
 562
 563     /*!
 564      * Export Mesh to MED_V2_1 MED format
 565      * Works, just the same as ExportToMEDX with MED_VERSION parameter equal to MED_V2_1
 566      * and overwrite parameter equal to true
 567      * The method is kept in order to support old functionality
 568      */
 569     void ExportMED( in string file, in boolean auto_groups )
 570       raises (SALOME::SALOME_Exception);
 571
 572     /*!
 573      * Return string representation of a MED file version comprising nbDigits
 574      */
 575     string GetVersionString(in MED_VERSION version, in short nbDigits);
 576
 577     /*!
 578      * Export Mesh to DAT, UNV and STL Formats
 579      * (UNV supported version is I-DEAS 10)
 580      */
 581     void ExportDAT( in string file )
 582       raises (SALOME::SALOME_Exception);
 583     void ExportUNV( in string file )
 584       raises (SALOME::SALOME_Exception);
 585     void ExportSTL( in string file, in boolean isascii )
 586       raises (SALOME::SALOME_Exception);
 587
 588     /*!
 589      * Get MED Mesh
 590      */
 591     SALOME_MED::MESH GetMEDMesh()
 592       raises (SALOME::SALOME_Exception);
 593
 594     /*!
 595      * Get informations about mesh contents
 596      */
 597     long NbNodes()
 598       raises (SALOME::SALOME_Exception);
 599
 600     long NbElements()
 601       raises (SALOME::SALOME_Exception);
 602
 603     long Nb0DElements()
 604       raises (SALOME::SALOME_Exception);
 605
 606     long NbEdges()
 607       raises (SALOME::SALOME_Exception);
 608
 609     long NbEdgesOfOrder(in ElementOrder order)
 610       raises (SALOME::SALOME_Exception);
 611
 612     long NbFaces()
 613       raises (SALOME::SALOME_Exception);
 614
 615     long NbFacesOfOrder(in ElementOrder order)
 616       raises (SALOME::SALOME_Exception);
 617
 618     long NbTriangles()
 619       raises (SALOME::SALOME_Exception);
 620
 621     long NbTrianglesOfOrder(in ElementOrder order)
 622       raises (SALOME::SALOME_Exception);
 623
 624     long NbQuadrangles()
 625       raises (SALOME::SALOME_Exception);
 626
 627     long NbQuadranglesOfOrder(in ElementOrder order)
 628       raises (SALOME::SALOME_Exception);
 629
 630     long NbPolygons()
 631       raises (SALOME::SALOME_Exception);
 632
 633     long NbVolumes()
 634       raises (SALOME::SALOME_Exception);
 635
 636     long NbVolumesOfOrder(in ElementOrder order)
 637       raises (SALOME::SALOME_Exception);
 638
 639     long NbTetras()
 640       raises (SALOME::SALOME_Exception);
 641
 642     long NbTetrasOfOrder(in ElementOrder order)
 643       raises (SALOME::SALOME_Exception);
 644
 645     long NbHexas()
 646       raises (SALOME::SALOME_Exception);
 647
 648     long NbHexasOfOrder(in ElementOrder order)
 649       raises (SALOME::SALOME_Exception);
 650
 651     long NbPyramids()
 652       raises (SALOME::SALOME_Exception);
 653
 654     long NbPyramidsOfOrder(in ElementOrder order)
 655       raises (SALOME::SALOME_Exception);
 656
 657     long NbPrisms()
 658       raises (SALOME::SALOME_Exception);
 659
 660     long NbPrismsOfOrder(in ElementOrder order)
 661       raises (SALOME::SALOME_Exception);
 662
 663     long NbPolyhedrons()
 664       raises (SALOME::SALOME_Exception);
 665
 666     long NbSubMesh()
 667       raises (SALOME::SALOME_Exception);
 668
 669     long_array GetElementsId()
 670       raises (SALOME::SALOME_Exception);
 671
 672     long_array GetElementsByType( in ElementType theType )
 673       raises (SALOME::SALOME_Exception);
 674
 675     long_array GetNodesId()
 676       raises (SALOME::SALOME_Exception);
 677
 678     /*!
 679      * Returns type of mesh element
 680      */
 681     ElementType GetElementType( in long id, in boolean iselem )
 682       raises (SALOME::SALOME_Exception);
 683
 684     EntityType GetElementGeomType( in long id )
 685       raises (SALOME::SALOME_Exception);
 686
 687     long_array GetSubMeshElementsId(in long ShapeID)
 688       raises (SALOME::SALOME_Exception);
 689
 690     long_array GetSubMeshNodesId(in long ShapeID, in boolean all )
 691       raises (SALOME::SALOME_Exception);
 692
 693     ElementType GetSubMeshElementType(in long ShapeID)
 694       raises (SALOME::SALOME_Exception);
 695
 696
 697     /*!
 698      * Methods to set meshing order of submeshes
 699      */
 700
 701     /*!
 702      * \brief Return submesh objects list in meshing order
 703      */
 704     submesh_array_array GetMeshOrder();
 705
 706     /*!
 707      * \brief Set submesh object order
 708      */
 709     boolean SetMeshOrder(in submesh_array_array theSubMeshArray);
 710
 711
 712     /*!
 713      * Get mesh description
 714      */
 715     string Dump();
 716
 717     /*!
 718      * Get mesh pointer
 719      */
 720     long long GetMeshPtr();
 721
 722     /*!
 723      * Get XYZ coordinates of node as list of double
 724      * If there is not node for given ID - returns empty list
 725      */
 726     double_array GetNodeXYZ(in long id);
 727
 728     /*!
 729      * For given node returns list of IDs of inverse elements
 730      * If there is not node for given ID - returns empty list
 731      */
 732     long_array GetNodeInverseElements(in long id);
 733
 734     /*!
 735      * \brief Return position of a node on shape
 736      */
 737     NodePosition GetNodePosition(in long NodeID);
 738
 739     /*!
 740      * If given element is node returns IDs of shape from position
 741      * If there is not node for given ID - returns -1
 742      */
 743     long GetShapeID(in long id);
 744
 745     /*!
 746      * For given element returns ID of result shape after
 747      * ::FindShape() from SMESH_MeshEditor
 748      * If there is not element for given ID - returns -1
 749      */
 750     long GetShapeIDForElem(in long id);
 751
 752     /*!
 753      * Returns number of nodes for given element
 754      * If there is not element for given ID - returns -1
 755      */
 756     long GetElemNbNodes(in long id);
 757
 758     /*!
 759      * Returns IDs of nodes of given element
 760      */
 761     long_array GetElemNodes(in long id);
 762
 763     /*!
 764      * Returns ID of node by given index for given element
 765      * If there is not element for given ID - returns -1
 766      * If there is not node for given index - returns -2
 767      */
 768     long GetElemNode(in long id, in long index);
 769
 770     /*!
 771      * Returns true if given node is medium node
 772      * in given quadratic element
 773      */
 774     boolean IsMediumNode(in long ide, in long idn);
 775
 776     /*!
 777      * Returns true if given node is medium node
 778      * in one of quadratic elements
 779      */
 780     boolean IsMediumNodeOfAnyElem(in long idn, in ElementType elem_type);
 781
 782     /*!
 783      * Returns number of edges for given element
 784      */
 785     long ElemNbEdges(in long id);
 786
 787     /*!
 788      * Returns number of faces for given element
 789      */
 790     long ElemNbFaces(in long id);
 791
 792     /*!
 793      * Returns nodes of given face (counted from zero) for given volumic element.
 794      */
 795     long_array GetElemFaceNodes(in long elemId, in short faceIndex);
 796
 797     /*!
 798      * Returns an element based on all given nodes.
 799      */
 800     long FindElementByNodes(in long_array nodes);
 801
 802     /*!
 803      * Returns true if given element is polygon
 804      */
 805     boolean IsPoly(in long id);
 806
 807     /*!
 808      * Returns true if given element is quadratic
 809      */
 810     boolean IsQuadratic(in long id);
 811
 812     /*!
 813      * Returns XYZ coordinates of bary center for given element
 814      * as list of double
 815      * If there is not element for given ID - returns empty list
 816      */
 817     double_array BaryCenter(in long id);
 818
 819     /*! Gets information about imported MED file */
 820     SALOME_MED::MedFileInfo GetMEDFileInfo();
 821
 822     /*!
 823      *  Sets list of notebook variables used for Mesh operations separated by ":" symbol
 824      *  \param theParameters is a string containing the notebook variables
 825      */
 826     void SetParameters (in string theParameters);
 827
 828     /*!
 829      *  Returns list of notebook variables used for Mesh operations separated by ":" symbol
 830      */
 831     string GetParameters();
 832
 833     /*!
 834      *  Returns list of notebook variables used for last Mesh operation
 835      */
 836     string_array GetLastParameters();
 837   };
 838
 839   interface SMESH_subMesh : SALOME::GenericObj, SMESH_IDSource
 840   {
 841     /*!
 842      *
 843      */
 844     long GetNumberOfElements()
 845       raises (SALOME::SALOME_Exception);
 846
 847     /*!
 848      *
 849      */
 850     long GetNumberOfNodes( in boolean all )
 851       raises (SALOME::SALOME_Exception);
 852
 853     /*!
 854      *
 855      */
 856     long_array GetElementsId()
 857       raises (SALOME::SALOME_Exception);
 858
 859     /*!
 860      *
 861      */
 862     long_array GetElementsByType( in ElementType theType )
 863       raises (SALOME::SALOME_Exception);
 864
 865     /*!
 866      * Return type of submesh element
 867      */
 868     ElementType GetElementType( in long id, in boolean iselem )
 869       raises (SALOME::SALOME_Exception);
 870
 871     /*!
 872      *
 873      */
 874     long_array GetNodesId()
 875       raises (SALOME::SALOME_Exception);
 876
 877     /*!
 878      * Get geom shape the submesh is dedicated to
 879      */
 880     GEOM::GEOM_Object GetSubShape()
 881       raises (SALOME::SALOME_Exception);
 882
 883     /*!
 884      * Get SMESH_Mesh which stores nodes coordinates & elements definition
 885      */
 886     SMESH_Mesh GetFather()
 887       raises (SALOME::SALOME_Exception);
 888
 889     /*!
 890      * Get the internal Id
 891      */
 892     long GetId();
 893
 894     /*!
 895      * Get MED subMesh
 896      */
 897     SALOME_MED::FAMILY GetFamily()
 898       raises (SALOME::SALOME_Exception);
 899   };
 900
 901 };
 902
 903 #endif