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