src/IntStart/IntStart_SearchInside.cdl

   1 -- Created on: 1992-05-15
   2 -- Created by: Jacques GOUSSARD
   3 -- Copyright (c) 1992-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 generic class SearchInside from IntStart (
  18        ThePSurface     as any;
  19        ThePSurfaceTool as any;
  20        TheTopolTool    as Transient; -- as SITopolTool from IntStart
  21        TheSITool       as any;
  22        TheFunction     as any)
  23
  24
  25         ---Purpose:
  26
  27 uses InteriorPoint           from IntSurf,
  28      SequenceOfInteriorPoint from IntSurf
  29
  30
  31 raises NotDone    from StdFail,
  32        OutOfRange from Standard
  33
  34
  35 is
  36
  37     Create
  38
  39         returns SearchInside from IntStart;
  40
  41
  42     Create (F: in out TheFunction; Surf: ThePSurface; T: TheTopolTool;
  43             Epsilon : Real from Standard)
  44
  45         returns SearchInside from IntStart;
  46
  47
  48     Perform(me: in out; F: in out TheFunction; Surf: ThePSurface;
  49                         T: TheTopolTool;
  50                         Epsilon: Real from Standard)
  51
  52         is static;
  53
  54     Perform(me: in out; F: in out TheFunction; Surf: ThePSurface;
  55                         UStart,VStart: Real from Standard)
  56
  57         is static;
  58
  59
  60     IsDone(me)
  61
  62         returns Boolean
  63         ---C++: inline
  64
  65         is static;
  66
  67
  68     NbPoints(me)
  69
  70         ---Purpose: Returns the number of points.
  71         --          The exception NotDone if raised if IsDone
  72         --          returns False.
  73
  74         returns Integer
  75         ---C++: inline
  76
  77         raises NotDone from StdFail
  78
  79         is static;
  80
  81
  82     Value(me; Index: Integer)
  83
  84         ---Purpose: Returns the point of range Index.
  85         --          The exception NotDone if raised if IsDone
  86         --          returns False.
  87         --          The exception OutOfRange if raised if
  88         --          Index <= 0 or Index > NbPoints.
  89
  90         returns InteriorPoint from IntSurf
  91         ---C++: return const&
  92         ---C++: inline
  93
  94         raises NotDone from StdFail,
  95                OutOfRange from Standard
  96
  97         is static;
  98
  99
 100 fields
 101
 102     done : Boolean                 from Standard;
 103     list : SequenceOfInteriorPoint from IntSurf;
 104
 105 end SearchInside;