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