src/TDataStd/TDataStd_ChildNodeIterator.cdl

   1 -- File:        TDataStd_ChildNodeIterator.cdl
   2 -- Created:     Wed Jan 26 16:32:08 2000
   3 -- Author:      Denis PASCAL
   4 --              <dp@dingox.paris1.matra-dtv.fr>
   5 ---Copyright:    Matra Datavision 2000
   6
   7
   8 class ChildNodeIterator from TDataStd
   9
  10         ---Purpose:  Iterates on the  ChildStepren step of  a step, at the
  11         --           first level  only.   It  is possible  to ask  the
  12         --          iterator to explore all the sub step levels of the
  13         --          given one, with the option "allLevels".
  14
  15 uses TreeNode from TDataStd
  16
  17 is
  18
  19     Create
  20         returns ChildNodeIterator from TDataStd;
  21         ---Purpose: Creates an empty iterator.
  22
  23     Create(aTreeNode : TreeNode from TDataStd;
  24            allLevels : Boolean from Standard = Standard_False)
  25         returns ChildNodeIterator from TDataStd;
  26         ---Purpose: Iterates on the ChildStepren of the given Step. If
  27         --          <allLevels> option is set to true, it explores not
  28         --          only the first, but all the sub Step levels.
  29
  30     Initialize(me : in out;
  31                aTreeNode : TreeNode from TDataStd;
  32                allLevels : Boolean from Standard = Standard_False);
  33         ---Purpose: Initializes the iteration on  the Children Step of
  34         --          the  given Step. If <allLevels>  option is  set to
  35         --          true, it explores not  only the first, but all the
  36         --          sub Step levels.
  37
  38     More(me) returns Boolean;
  39         ---C++: inline
  40         ---Purpose: Returns True if there is a current Item in the
  41         --          iteration.
  42
  43     Next(me : in out);
  44         ---Purpose: Move to the next Item
  45
  46     NextBrother(me : in out);
  47         ---Purpose: Move to the next Brother. If there is none, go up
  48         --          etc. This method is interesting only with
  49         --          "allLevels" behavior, because it avoids to explore
  50         --          the current Step ChildStepren.
  51
  52     Value(me) returns TreeNode from TDataStd;
  53         ---C++: inline
  54         ---Purpose: Returns the current item; a null Step if there is
  55         --          no one.
  56
  57 fields
  58
  59     myNode       : TreeNode from TDataStd;
  60     myFirstLevel : Integer  from Standard;
  61
  62 end ChildNodeIterator;
  63
  64
  65
  66
  67