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_Mesh;
 252
 253   interface SMESH_IDSource
 254   {
 255     /*!
 256      * Returns a sequence of all element IDs
 257      */
 258     long_array GetIDs();
 259
 260     /*!
 261      * Returns statistic of mesh elements
 262      * Result array of number enityties
 263      */
 264     long_array GetMeshInfo();
 265
 266     /*!
 267      * Returns types of elements it contains.
 268      * It's empty if the SMESH_IDSource contains no IDs
 269      */
 270     array_of_ElementType GetTypes();
 271
 272     /*!
 273      * Returns the mesh
 274      */
 275     SMESH_Mesh GetMesh();
 276   };
 277
 278   interface SMESH_Group;
 279   interface SMESH_GroupOnGeom;
 280   interface SMESH_subMesh;
 281   interface SMESH_MeshEditor;
 282
 283   typedef sequence<SMESH_subMesh>     submesh_array;
 284   typedef sequence<submesh_array>     submesh_array_array;
 285
 286   interface SMESH_Mesh : SALOME::GenericObj, SMESH_IDSource
 287   {
 288     /*!
 289      * Return true if there is a geometry to be meshed
 290      */
 291     boolean HasShapeToMesh()
 292       raises (SALOME::SALOME_Exception);
 293
 294     /*!
 295      * Get geom shape to mesh. A result sould not be nil. Use HasShapeToMesh()
 296      * to know if a returned shape
 297      */
 298     GEOM::GEOM_Object GetShapeToMesh()
 299       raises (SALOME::SALOME_Exception);
 300
 301     /*!
 302      * Remove all nodes and elements
 303      */
 304     void Clear()
 305       raises (SALOME::SALOME_Exception);
 306
 307     /*!
 308      * Remove all nodes and elements of submesh
 309      */
 310     void ClearSubMesh(in long ShapeID)
 311       raises (SALOME::SALOME_Exception);
 312
 313     /*!
 314      * Get the subMesh object associated to a subShape. The subMesh object
 315      * gives access to nodes and elements IDs.
 316      * SubMesh will be used instead of SubShape in a next idl version to
 317      * adress a specific subMesh...
 318      */
 319     SMESH_subMesh GetSubMesh(in GEOM::GEOM_Object aSubObject, in string name)
 320       raises (SALOME::SALOME_Exception);
 321
 322     /*!
 323      * Remove a submesh
 324      */
 325     void RemoveSubMesh(in SMESH_subMesh aSubMesh)
 326       raises (SALOME::SALOME_Exception);
 327
 328
 329     /*!
 330      * Create a group
 331      */
 332     SMESH_Group CreateGroup( in ElementType elem_type,
 333                              in string name )
 334       raises (SALOME::SALOME_Exception);
 335
 336     /*!
 337      * Create a group from geometry group
 338      */
 339     SMESH_GroupOnGeom CreateGroupFromGEOM( in ElementType elem_type,
 340                                           in string name,
 341                                           in GEOM::GEOM_Object theGeomObject )
 342       raises (SALOME::SALOME_Exception);
 343
 344     /*!
 345      * Remove a group
 346      */
 347     void RemoveGroup(in SMESH_GroupBase aGroup)
 348       raises (SALOME::SALOME_Exception);
 349
 350     /*!
 351      *  Remove group with its contents
 352      */
 353     void RemoveGroupWithContents( in SMESH_GroupBase aGroup )
 354       raises (SALOME::SALOME_Exception);
 355
 356     /*!
 357      *  Get the list of groups existing in the mesh
 358      */
 359     ListOfGroups GetGroups()
 360       raises (SALOME::SALOME_Exception);
 361
 362     /*!
 363      *  Get number of groups existing in the mesh
 364      */
 365     long NbGroups()
 366       raises (SALOME::SALOME_Exception);
 367
 368     /*!
 369      * Union of two groups
 370      *    New group is created. All mesh elements that are
 371      *    present in initial groups are added to the new one
 372      */
 373     SMESH_Group UnionGroups (in SMESH_GroupBase aGroup1,
 374                              in SMESH_GroupBase aGroup2,
 375                              in string          name )
 376       raises (SALOME::SALOME_Exception);
 377
 378     /*!
 379      * Union of list of groups
 380      * New group is created. All mesh elements that are
 381      * present in initial groups are added to the new one
 382      */
 383     SMESH_Group UnionListOfGroups (in ListOfGroups aListOfGroups,
 384                                    in string       name )
 385       raises (SALOME::SALOME_Exception);
 386
 387     /*!
 388      *  Intersection of two groups
 389      *  New group is created. All mesh elements that are
 390      *  present in both initial groups are added to the new one.
 391      */
 392     SMESH_Group IntersectGroups (in SMESH_GroupBase aGroup1,
 393                                  in SMESH_GroupBase aGroup2,
 394                                  in string          name )
 395       raises (SALOME::SALOME_Exception);
 396
 397     /*!
 398      *  Intersection of list of groups
 399      *  New group is created. All mesh elements that are
 400      *  present in all initial groups simultaneously are added to the new one.
 401      */
 402     SMESH_Group IntersectListOfGroups (in ListOfGroups aListOfGroups,
 403                                        in string       name)
 404       raises (SALOME::SALOME_Exception);
 405
 406     /*!
 407      *  Cut of two groups
 408      *  New group is created. All mesh elements that are present in
 409      *  main group but do not present in tool group are added to the new one
 410      */
 411     SMESH_Group CutGroups (in SMESH_GroupBase aMainGroup,
 412                            in SMESH_GroupBase aToolGroup,
 413                            in string          name )
 414       raises (SALOME::SALOME_Exception);
 415
 416     /*!
 417      *  Cut of lists of groups
 418      *  New group is created. All mesh elements that are present in
 419      *  main groups but do not present in tool groups are added to the new one
 420      */
 421     SMESH_Group CutListOfGroups (in ListOfGroups aMainGroups,
 422                                  in ListOfGroups aToolGroups,
 423                                  in string       name)
 424       raises (SALOME::SALOME_Exception);
 425
 426     /*!
 427      *  Create groups of entities from existing groups of superior dimensions
 428      *  New group is created. System
 429      *  1) extracts all nodes from each group,
 430      *  2) combines all elements of specified dimension laying on these nodes.
 431      */
 432     SMESH_Group CreateDimGroup( in ListOfGroups aListOfGroups,
 433                                 in ElementType  anElemType,
 434                                 in string       name )
 435       raises (SALOME::SALOME_Exception);
 436
 437     /*!
 438      * Convert group on geometry into standalone group
 439      */
 440     SMESH_Group ConvertToStandalone( in SMESH_GroupOnGeom theGeomGroup )
 441       raises (SALOME::SALOME_Exception);
 442
 443     /*!
 444      * Add hypothesis to the mesh, under a particular subShape
 445      * (or the main shape itself)
 446      * The Add method is only used to prepare the build of the mesh and store
 447      * the algorithms and associated parameters.
 448      * Actual job of mesh the shape is done by MESH_Gen.
 449      * @params
 450      * - aSubShape : subShape obtained by a shape explode in GEOM
 451      *   (or main shape)
 452      * - anHyp : hypothesis object
 453      * @return
 454      * - OK if the hypothesis is compatible with the subShape
 455      *   (and all previous hypothesis on the subShape)
 456      * - NOK if the hypothesis is not compatible with the subShape
 457      *   (or one previous hypothesis on the subShape)
 458      * raises exception if hypothesis has not been created
 459      */
 460     Hypothesis_Status AddHypothesis(in GEOM::GEOM_Object aSubObject,
 461                                     in SMESH_Hypothesis anHyp)
 462       raises (SALOME::SALOME_Exception);
 463 //     boolean AddHypothesis(in SMESH_subMesh aSubMesh, in SMESH_Hypothesis anHyp)
 464 //       raises (SALOME::SALOME_Exception);
 465
 466     /*!
 467      * Remove an hypothesis previouly added with AddHypothesis.
 468      */
 469     Hypothesis_Status RemoveHypothesis(in GEOM::GEOM_Object aSubObject,
 470                                        in SMESH_Hypothesis anHyp)
 471       raises (SALOME::SALOME_Exception);
 472 //     boolean RemoveHypothesis(in SMESH_subMesh aSubMesh,
 473 //                           in SMESH_Hypothesis anHyp)
 474 //       raises (SALOME::SALOME_Exception);
 475
 476     /*!
 477      * Get the list of hypothesis added on a subShape
 478      */
 479     ListOfHypothesis GetHypothesisList(in GEOM::GEOM_Object aSubObject)
 480       raises (SALOME::SALOME_Exception);
 481 //     ListOfHypothesis GetHypothesisList(in SMESH_subMesh aSubMesh)
 482 //       raises (SALOME::SALOME_Exception);
 483
 484     /*!
 485      * Get the log of nodes and elements added or removed since previous
 486      * clear of the log.
 487      * @params
 488      * - clearAfterGet : log is emptied after Get (safe if concurrents access)
 489      */
 490     //    string_array GetLog(in boolean clearAfterGet)
 491     //      raises (SALOME::SALOME_Exception);
 492     log_array GetLog(in boolean clearAfterGet)
 493       raises (SALOME::SALOME_Exception);
 494
 495     /*!
 496      * Clear the log of nodes and elements added or removed since previous
 497      * clear. Must be used immediately after GetLog if clearAfterGet is false.
 498      */
 499     void ClearLog()
 500       raises (SALOME::SALOME_Exception);
 501
 502     /*!
 503      * Toggle auto color mode on the object.
 504      * @params
 505      * - theAutoColor : flag which toggles auto color mode.
 506      */
 507     void SetAutoColor(in boolean theAutoColor)
 508       raises (SALOME::SALOME_Exception);
 509
 510     /*!
 511      * Get flag of object's auto color mode.
 512      */
 513     boolean GetAutoColor()
 514       raises (SALOME::SALOME_Exception);
 515
 516     /*!
 517      * Get the internal Id
 518      */
 519     long GetId();
 520
 521     /*!
 522      * Get the study Id
 523      */
 524     long GetStudyId();
 525
 526     /*!
 527      * Obtain instance of SMESH_MeshEditor
 528      */
 529     SMESH_MeshEditor GetMeshEditor()
 530       raises (SALOME::SALOME_Exception);
 531
 532     /*!
 533      * Return SMESH_MeshEditor that would not modify the mesh but
 534      * fill MeshPreviewStruct
 535      */
 536     SMESH_MeshEditor GetMeshEditPreviewer()
 537       raises (SALOME::SALOME_Exception);
 538
 539     /*!
 540      * Return true if the mesh has been edited since a total re-compute
 541      * and those modifications may prevent successful partial re-compute
 542      */
 543     boolean HasModificationsToDiscard()
 544       raises (SALOME::SALOME_Exception);
 545
 546     /*! Check group names for duplications.
 547      *  Consider maximum group name length stored in MED file.
 548      */
 549     boolean HasDuplicatedGroupNamesMED();
 550
 551     /*!
 552      * Export Mesh to different MED Formats
 553      * @params
 554      * - auto_groups : boolean parameter for creating/not creating
 555      *   the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
 556      *   the typical use is auto_groups=false.
 557      * - theVersion : define the version of format of MED file, that will be created
 558      * - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
 559      */
 560     void ExportToMEDX( in string file, in boolean auto_groups, in MED_VERSION theVersion, in boolean overwrite )
 561       raises (SALOME::SALOME_Exception);
 562
 563     /*!
 564      * Export Mesh to different MED Formats
 565      * Works, just the same as ExportToMEDX, with overwrite parameter equal to true.
 566      * The method is kept in order to support old functionality
 567      */
 568     void ExportToMED( in string file, in boolean auto_groups, in MED_VERSION theVersion )
 569       raises (SALOME::SALOME_Exception);
 570
 571     /*!
 572      * Export Mesh to MED_V2_1 MED format
 573      * Works, just the same as ExportToMEDX with MED_VERSION parameter equal to MED_V2_1
 574      * and overwrite parameter equal to true
 575      * The method is kept in order to support old functionality
 576      */
 577     void ExportMED( in string file, in boolean auto_groups )
 578       raises (SALOME::SALOME_Exception);
 579
 580     /*!
 581      * Return string representation of a MED file version comprising nbDigits
 582      */
 583     string GetVersionString(in MED_VERSION version, in short nbDigits);
 584
 585     /*!
 586      * Export Mesh to DAT, UNV and STL Formats
 587      * (UNV supported version is I-DEAS 10)
 588      */
 589     void ExportDAT( in string file )
 590       raises (SALOME::SALOME_Exception);
 591     void ExportUNV( in string file )
 592       raises (SALOME::SALOME_Exception);
 593     void ExportSTL( in string file, in boolean isascii )
 594       raises (SALOME::SALOME_Exception);
 595
 596     /*!
 597      * Get MED Mesh
 598      */
 599     SALOME_MED::MESH GetMEDMesh()
 600       raises (SALOME::SALOME_Exception);
 601
 602     /*!
 603      * Get informations about mesh contents
 604      */
 605     long NbNodes()
 606       raises (SALOME::SALOME_Exception);
 607
 608     long NbElements()
 609       raises (SALOME::SALOME_Exception);
 610
 611     long Nb0DElements()
 612       raises (SALOME::SALOME_Exception);
 613
 614     long NbEdges()
 615       raises (SALOME::SALOME_Exception);
 616
 617     long NbEdgesOfOrder(in ElementOrder order)
 618       raises (SALOME::SALOME_Exception);
 619
 620     long NbFaces()
 621       raises (SALOME::SALOME_Exception);
 622
 623     long NbFacesOfOrder(in ElementOrder order)
 624       raises (SALOME::SALOME_Exception);
 625
 626     long NbTriangles()
 627       raises (SALOME::SALOME_Exception);
 628
 629     long NbTrianglesOfOrder(in ElementOrder order)
 630       raises (SALOME::SALOME_Exception);
 631
 632     long NbQuadrangles()
 633       raises (SALOME::SALOME_Exception);
 634
 635     long NbQuadranglesOfOrder(in ElementOrder order)
 636       raises (SALOME::SALOME_Exception);
 637
 638     long NbPolygons()
 639       raises (SALOME::SALOME_Exception);
 640
 641     long NbVolumes()
 642       raises (SALOME::SALOME_Exception);
 643
 644     long NbVolumesOfOrder(in ElementOrder order)
 645       raises (SALOME::SALOME_Exception);
 646
 647     long NbTetras()
 648       raises (SALOME::SALOME_Exception);
 649
 650     long NbTetrasOfOrder(in ElementOrder order)
 651       raises (SALOME::SALOME_Exception);
 652
 653     long NbHexas()
 654       raises (SALOME::SALOME_Exception);
 655
 656     long NbHexasOfOrder(in ElementOrder order)
 657       raises (SALOME::SALOME_Exception);
 658
 659     long NbPyramids()
 660       raises (SALOME::SALOME_Exception);
 661
 662     long NbPyramidsOfOrder(in ElementOrder order)
 663       raises (SALOME::SALOME_Exception);
 664
 665     long NbPrisms()
 666       raises (SALOME::SALOME_Exception);
 667
 668     long NbPrismsOfOrder(in ElementOrder order)
 669       raises (SALOME::SALOME_Exception);
 670
 671     long NbPolyhedrons()
 672       raises (SALOME::SALOME_Exception);
 673
 674     long NbSubMesh()
 675       raises (SALOME::SALOME_Exception);
 676
 677     long_array GetElementsId()
 678       raises (SALOME::SALOME_Exception);
 679
 680     long_array GetElementsByType( in ElementType theType )
 681       raises (SALOME::SALOME_Exception);
 682
 683     long_array GetNodesId()
 684       raises (SALOME::SALOME_Exception);
 685
 686     /*!
 687      * Returns type of mesh element
 688      */
 689     ElementType GetElementType( in long id, in boolean iselem )
 690       raises (SALOME::SALOME_Exception);
 691
 692     EntityType GetElementGeomType( in long id )
 693       raises (SALOME::SALOME_Exception);
 694
 695     long_array GetSubMeshElementsId(in long ShapeID)
 696       raises (SALOME::SALOME_Exception);
 697
 698     long_array GetSubMeshNodesId(in long ShapeID, in boolean all )
 699       raises (SALOME::SALOME_Exception);
 700
 701     ElementType GetSubMeshElementType(in long ShapeID)
 702       raises (SALOME::SALOME_Exception);
 703
 704
 705     /*!
 706      * Methods to set meshing order of submeshes
 707      */
 708
 709     /*!
 710      * \brief Return submesh objects list in meshing order
 711      */
 712     submesh_array_array GetMeshOrder();
 713
 714     /*!
 715      * \brief Set submesh object order
 716      */
 717     boolean SetMeshOrder(in submesh_array_array theSubMeshArray);
 718
 719
 720     /*!
 721      * Get mesh description
 722      */
 723     string Dump();
 724
 725     /*!
 726      * Get mesh pointer
 727      */
 728     long long GetMeshPtr();
 729
 730     /*!
 731      * Get XYZ coordinates of node as list of double
 732      * If there is not node for given ID - returns empty list
 733      */
 734     double_array GetNodeXYZ(in long id);
 735
 736     /*!
 737      * For given node returns list of IDs of inverse elements
 738      * If there is not node for given ID - returns empty list
 739      */
 740     long_array GetNodeInverseElements(in long id);
 741
 742     /*!
 743      * \brief Return position of a node on shape
 744      */
 745     NodePosition GetNodePosition(in long NodeID);
 746
 747     /*!
 748      * If given element is node returns IDs of shape from position
 749      * If there is not node for given ID - returns -1
 750      */
 751     long GetShapeID(in long id);
 752
 753     /*!
 754      * For given element returns ID of result shape after
 755      * ::FindShape() from SMESH_MeshEditor
 756      * If there is not element for given ID - returns -1
 757      */
 758     long GetShapeIDForElem(in long id);
 759
 760     /*!
 761      * Returns number of nodes for given element
 762      * If there is not element for given ID - returns -1
 763      */
 764     long GetElemNbNodes(in long id);
 765
 766     /*!
 767      * Returns IDs of nodes of given element
 768      */
 769     long_array GetElemNodes(in long id);
 770
 771     /*!
 772      * Returns ID of node by given index for given element
 773      * If there is not element for given ID - returns -1
 774      * If there is not node for given index - returns -2
 775      */
 776     long GetElemNode(in long id, in long index);
 777
 778     /*!
 779      * Returns true if given node is medium node
 780      * in given quadratic element
 781      */
 782     boolean IsMediumNode(in long ide, in long idn);
 783
 784     /*!
 785      * Returns true if given node is medium node
 786      * in one of quadratic elements
 787      */
 788     boolean IsMediumNodeOfAnyElem(in long idn, in ElementType elem_type);
 789
 790     /*!
 791      * Returns number of edges for given element
 792      */
 793     long ElemNbEdges(in long id);
 794
 795     /*!
 796      * Returns number of faces for given element
 797      */
 798     long ElemNbFaces(in long id);
 799
 800     /*!
 801      * Returns nodes of given face (counted from zero) for given volumic element.
 802      */
 803     long_array GetElemFaceNodes(in long elemId, in short faceIndex);
 804
 805     /*!
 806      * Returns an element based on all given nodes.
 807      */
 808     long FindElementByNodes(in long_array nodes);
 809
 810     /*!
 811      * Returns true if given element is polygon
 812      */
 813     boolean IsPoly(in long id);
 814
 815     /*!
 816      * Returns true if given element is quadratic
 817      */
 818     boolean IsQuadratic(in long id);
 819
 820     /*!
 821      * Returns XYZ coordinates of bary center for given element
 822      * as list of double
 823      * If there is not element for given ID - returns empty list
 824      */
 825     double_array BaryCenter(in long id);
 826
 827     /*! Gets information about imported MED file */
 828     SALOME_MED::MedFileInfo GetMEDFileInfo();
 829
 830     /*!
 831      *  Sets list of notebook variables used for Mesh operations separated by ":" symbol
 832      *  \param theParameters is a string containing the notebook variables
 833      */
 834     void SetParameters (in string theParameters);
 835
 836     /*!
 837      *  Returns list of notebook variables used for Mesh operations separated by ":" symbol
 838      */
 839     string GetParameters();
 840
 841     /*!
 842      *  Returns list of notebook variables used for last Mesh operation
 843      */
 844     string_array GetLastParameters();
 845   };
 846
 847   interface SMESH_subMesh : SALOME::GenericObj, SMESH_IDSource
 848   {
 849     /*!
 850      *
 851      */
 852     long GetNumberOfElements()
 853       raises (SALOME::SALOME_Exception);
 854
 855     /*!
 856      *
 857      */
 858     long GetNumberOfNodes( in boolean all )
 859       raises (SALOME::SALOME_Exception);
 860
 861     /*!
 862      *
 863      */
 864     long_array GetElementsId()
 865       raises (SALOME::SALOME_Exception);
 866
 867     /*!
 868      *
 869      */
 870     long_array GetElementsByType( in ElementType theType )
 871       raises (SALOME::SALOME_Exception);
 872
 873     /*!
 874      * Return type of submesh element
 875      */
 876     ElementType GetElementType( in long id, in boolean iselem )
 877       raises (SALOME::SALOME_Exception);
 878
 879     /*!
 880      *
 881      */
 882     long_array GetNodesId()
 883       raises (SALOME::SALOME_Exception);
 884
 885     /*!
 886      * Get geom shape the submesh is dedicated to
 887      */
 888     GEOM::GEOM_Object GetSubShape()
 889       raises (SALOME::SALOME_Exception);
 890
 891     /*!
 892      * Get SMESH_Mesh which stores nodes coordinates & elements definition
 893      */
 894     SMESH_Mesh GetFather()
 895       raises (SALOME::SALOME_Exception);
 896
 897     /*!
 898      * Get the internal Id
 899      */
 900     long GetId();
 901
 902     /*!
 903      * Get MED subMesh
 904      */
 905     SALOME_MED::FAMILY GetFamily()
 906       raises (SALOME::SALOME_Exception);
 907   };
 908
 909 };
 910
 911 #endif