src/SMDS/SMDS_MeshElementsIterator.cdl

   1 --  SMESH SMDS : implementaion of Salome mesh data structure
   2 --
   3 --  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 --  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 --
   6 --  This library is free software; you can redistribute it and/or
   7 --  modify it under the terms of the GNU Lesser General Public
   8 --  License as published by the Free Software Foundation; either
   9 --  version 2.1 of the License.
  10 --
  11 --  This library is distributed in the hope that it will be useful,
  12 --  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 --  Lesser General Public License for more details.
  15 --
  16 --  You should have received a copy of the GNU Lesser General Public
  17 --  License along with this library; if not, write to the Free Software
  18 --  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 --
  20 --  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  21 --
  22 --
  23 --
  24 --  File   : SMDS_MeshElementsIterator.cdl
  25 --  Author : Jean-Michel BOULCOURT
  26 --  Module : SMESH
  27
  28 deferred class MeshElementsIterator from SMDS
  29
  30         ---Purpose: The Iterator objet to iterate on all faces of a mesh
  31         --
  32
  33 uses
  34     Mesh from SMDS,
  35     MeshElement from SMDS,
  36     MapIteratorOfExtendedOrientedMap from SMDS
  37
  38 raises
  39     NoMoreObject,
  40     NoSuchObject
  41
  42 is
  43
  44     Delete(me:out) is virtual;
  45     ---C++: alias "Standard_EXPORT virtual ~SMDS_MeshElementsIterator(){Delete();}"
  46
  47     Initialize(me : in out; M      : Mesh from SMDS)
  48         ---Purpose: Reset the Iterator on the faces of mesh <M>.
  49     is deferred;
  50
  51     More(me) returns Boolean
  52         ---Purpose: Returns True if there is a current meshface.
  53         --
  54         ---C++: inline
  55     is static;
  56
  57     Next(me : in out)
  58         ---Purpose: Moves to the next face.
  59     raises
  60         NoMoreObject from Standard
  61     is static;
  62
  63     Value(me) returns MeshElement from SMDS
  64         ---Purpose: Returns the meshface.
  65     raises
  66         NoSuchObject from Standard
  67         ---C++: return const &
  68         ---C++: inline
  69     is static;
  70
  71
  72 fields
  73     myCurrentMeshElement        : MeshElement  from SMDS is protected;
  74     myMapIterator : MapIteratorOfExtendedOrientedMap from SMDS is protected;
  75
  76 end MeshElementsIterator;