src/BOP/BOP_BlockIterator.cdl

   1 -- Created on: 1993-02-25
   2 -- Created by: Jean Yves LEBEY
   3 -- Copyright (c) 1993-1999 Matra Datavision
   4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22 class BlockIterator from BOP
  23
  24     ---Purpose:
  25
  26     --  Auxiliary class to provide
  27     --  simple iteration on indexes that
  28     --  belongs to the integer range  [Lower,Upper]
  29     --  with increment =1
  30
  31 raises
  32
  33     NoMoreObject from Standard
  34
  35 is
  36
  37     Create
  38         returns BlockIterator from BOP;
  39         ---Purpose:
  40         --- Empty  Constructor
  41         ---
  42     Create(Lower,Upper : Integer from Standard)
  43         returns BlockIterator from BOP;
  44         ---Purpose:
  45         --- Creates an object with initial range
  46         --- of  [Lower,Upper]
  47         ---
  48
  49     Initialize(me : in out)
  50         is static;
  51         ---Purpose:
  52         --- Initialize an object with initial range
  53         --- of  [Lower,Upper]
  54         ---
  55     More(me)
  56         returns Boolean from Standard
  57         is static;
  58         ---Purpose:
  59         --- Support of Iteration
  60         ---
  61     Next(me : in out)
  62         raises NoMoreObject
  63         is static;
  64         ---Purpose:
  65         --- Support of Iteration
  66         ---
  67     Value(me)
  68         returns Integer from Standard
  69         is static;
  70         ---Purpose:
  71         --- Support of Iteration
  72         ---
  73     Extent(me)
  74         returns Integer from Standard
  75         is static;
  76         ---Purpose:
  77         --- Returns the extension=myUpper - myLower + 1;
  78         ---
  79
  80 fields
  81
  82     myLower : Integer from Standard;
  83     myUpper : Integer from Standard;
  84     myValue : Integer from Standard;
  85
  86 end BlockIterator;