src/SMDS/SMDS_MeshElementsIterator.cdl

   1 -- File:        SMDS_MeshElementsIterator.cdl
   2 -- Created:     Thu Jan 24 12:00:41 2002
   3 -- Author:      Jean-Michel BOULCOURT
   4 --              <jmb@coulox.paris1.matra-dtv.fr>
   5 ---Copyright:    Matra Datavision 2002
   6
   7
   8 deferred class MeshElementsIterator from SMDS
   9
  10         ---Purpose: The Iterator objet to iterate on all faces of a mesh
  11         --
  12
  13 uses
  14     Mesh from SMDS,
  15     MeshElement from SMDS,
  16     MapIteratorOfExtendedOrientedMap from SMDS
  17
  18 raises
  19     NoMoreObject,
  20     NoSuchObject
  21
  22 is
  23
  24     Delete(me:out) is virtual;
  25     ---C++: alias "Standard_EXPORT virtual ~SMDS_MeshElementsIterator(){Delete();}"
  26
  27     Initialize(me : in out; M      : Mesh from SMDS)
  28         ---Purpose: Reset the Iterator on the faces of mesh <M>.
  29     is deferred;
  30
  31     More(me) returns Boolean
  32         ---Purpose: Returns True if there is a current meshface.
  33         --
  34         ---C++: inline
  35     is static;
  36
  37     Next(me : in out)
  38         ---Purpose: Moves to the next face.
  39     raises
  40         NoMoreObject from Standard
  41     is static;
  42
  43     Value(me) returns MeshElement from SMDS
  44         ---Purpose: Returns the meshface.
  45     raises
  46         NoSuchObject from Standard
  47         ---C++: return const &
  48         ---C++: inline
  49     is static;
  50
  51
  52 fields
  53     myCurrentMeshElement        : MeshElement  from SMDS is protected;
  54     myMapIterator : MapIteratorOfExtendedOrientedMap from SMDS is protected;
  55
  56 end MeshElementsIterator;