src/GeomFill/GeomFill_Profiler.cdl

   1 -- File:        GeomFill_Profiler.cdl
   2 -- Created:     Thu Feb 17 10:44:36 1994
   3 -- Author:      Bruno DUMORTIER
   4 --              <dub@fuegox>
   5 ---Copyright:    Matra Datavision 1994
   6
   7
   8
   9
  10 class Profiler from GeomFill
  11
  12         ---Purpose: Evaluation of the common BSplineProfile of a group
  13         --          of curves  from Geom. All the curves will have the
  14         --          same  degree,  the same knot-vector, so  the  same
  15         --          number of poles.
  16
  17
  18 uses
  19     Array1OfReal    from TColStd,
  20     Array1OfInteger from TColStd,
  21     Array1OfPnt     from TColgp,
  22     Curve           from Geom,
  23     SequenceOfCurve from TColGeom
  24
  25
  26 raises
  27     NotDone     from StdFail,
  28     DomainError from Standard
  29
  30 is
  31     Create returns Profiler from GeomFill;
  32
  33     Delete(me:out) is virtual;
  34     ---C++: alias "Standard_EXPORT virtual ~GeomFill_Profiler(){Delete() ; }"
  35
  36     AddCurve( me    : in out;
  37               Curve : in Curve from Geom)
  38     is static;
  39
  40     Perform(me   : in out ;
  41             PTol : in Real from Standard)
  42         ---Purpose: Converts all curves to BSplineCurves.
  43         --          Set them to the common profile.
  44         --          <PTol> is used to compare 2 knots.
  45     is virtual;
  46
  47     Degree(me) returns Integer from Standard
  48     raises
  49         NotDone from StdFail
  50         ---Purpose: Raises if not yet perform
  51     is static;
  52
  53     IsPeriodic(me) returns Boolean from Standard
  54         ---C++: inline
  55     is static;
  56
  57     NbPoles(me) returns Integer from Standard
  58     raises
  59         NotDone from StdFail
  60         ---Purpose: Raises if not yet perform
  61     is static;
  62
  63     Poles(me; Index : in     Integer     from Standard;
  64               Poles : in out Array1OfPnt from TColgp)
  65         ---Purpose: returns in <Poles> the  poles  of the BSplineCurve
  66         --          from index <Index> adjusting to the current profile.
  67     raises
  68         NotDone     from StdFail,
  69         ---Purpose: Raises if not yet perform
  70         DomainError from Standard
  71         ---Purpose: Raises if <Index> not in the range [1,NbCurves]
  72         --          if  the  length  of  <Poles>  is  not  equal  to
  73         --          NbPoles().
  74     is static;
  75
  76     Weights(me; Index   : in     Integer      from Standard;
  77                 Weights : in out Array1OfReal from TColStd)
  78         ---Purpose: returns in <Weights> the weights of the BSplineCurve
  79         --          from index <Index> adjusting to the current profile.
  80     raises
  81         NotDone from StdFail,
  82         ---Purpose: Raises if not yet perform
  83         DomainError from Standard
  84         ---Purpose: Raises if <Index> not in the range [1,NbCurves] or
  85         --          if  the  length  of  <Weights>  is  not  equal  to
  86         --          NbPoles().
  87     is static;
  88
  89     NbKnots(me) returns Integer from Standard
  90     raises
  91         NotDone from StdFail
  92         ---Purpose: Raises if not yet perform
  93     is static;
  94
  95     KnotsAndMults(me;
  96                   Knots : in out Array1OfReal    from TColStd;
  97                   Mults : in out Array1OfInteger from TColStd)
  98     raises
  99         NotDone from StdFail,
 100         ---Purpose: Raises if not yet perform
 101         DomainError from Standard
 102         ---Purpose: Raises if  the lengthes of <Knots> and <Mults> are
 103         --          not equal to NbKnots().
 104     is static;
 105
 106     Curve(me; Index : Integer from Standard)
 107     returns Curve from Geom
 108         ---C++: return const&
 109         ---C++: inline
 110     is static;
 111
 112
 113 fields
 114     mySequence   : SequenceOfCurve from TColGeom is protected;
 115     myIsDone     : Boolean         from Standard is protected;
 116     myIsPeriodic : Boolean         from Standard is protected;
 117
 118 end Profiler;