0024624: Lost word in license statement in source files
[occt.git] / src / BRepBlend / BRepBlend_CurvPointRadInv.cdl
1 -- Created on: 1997-02-12
2 -- Created by: Laurent BOURESCHE
3 -- Copyright (c) 1997-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 class CurvPointRadInv from BRepBlend
18
19 inherits CurvPointFuncInv from Blend 
20
21     ---Purpose: This function  is used  to find a  solution on  a done
22     --          point   of   the curve 1 when   using  RstRstConsRad or
23     --          CSConstRad... 
24     --          The vector <X>  used in Value, Values and  Derivatives
25     --          methods  has  to   be the  vector   of the  parametric
26     --          coordinates w, U where w is  the parameter  on the
27     --          guide line, U   are the parametric coordinates of  a
28     --          point on the partner curve 2.
29
30 uses
31     Pnt      from gp,
32     Vector   from math,
33     Matrix   from math,
34     HCurve   from Adaptor3d
35
36
37 is
38     Create(C1 : HCurve from Adaptor3d; C2  : HCurve from Adaptor3d)
39     returns CurvPointRadInv from BRepBlend;
40         
41     Set(me: in out; Choix: Integer from Standard)
42     is static;
43
44     NbEquations(me)
45     ---Purpose: returns 2.
46     returns Integer from Standard;
47
48     Value(me: in out; X: Vector; F: out Vector)
49     ---Purpose: computes the values <F> of the Functions for the 
50     --          variable <X>.
51     --          Returns True if the computation was done successfully, 
52     --          False otherwise.
53     returns Boolean from Standard;
54     
55     Derivatives(me: in out; X: Vector; D: out Matrix)
56     ---Purpose: returns the values <D> of the derivatives for the 
57     --          variable <X>.
58     --          Returns True if the computation was done successfully, 
59     --          False otherwise.
60     returns Boolean from Standard;
61     
62     Values(me: in out; X: Vector; F: out Vector; D: out Matrix)
63     ---Purpose: returns the values <F> of the functions and the derivatives
64     --          <D> for the variable <X>.
65     --          Returns True if the computation was done successfully, 
66     --          False otherwise.
67     returns Boolean from Standard;
68
69     Set(me: in out; P : Pnt from gp);
70     ---Purpose: Set the Point on which a solution has to be found.
71
72     GetTolerance(me; Tolerance: out Vector from math; Tol: Real from Standard);
73     ---Purpose: Returns in the vector Tolerance the parametric tolerance
74     --          for each of the 3 variables;
75     --          Tol is the tolerance used in 3d space.
76
77     GetBounds(me; InfBound,SupBound: out Vector from math);
78     ---Purpose: Returns in the vector InfBound the lowest values allowed
79     --          for each of the 3 variables.
80     --          Returns in the vector SupBound the greatest values allowed
81     --          for each of the 3 variables.
82
83     IsSolution(me: in out; Sol: Vector from math; Tol: Real from Standard)
84     ---Purpose: Returns Standard_True if Sol is a zero of the function.
85     --          Tol is the tolerance used in 3d space.
86     returns Boolean from Standard;
87
88 fields
89
90     curv1 : HCurve   from Adaptor3d;
91     curv2 : HCurve   from Adaptor3d;
92     point : Pnt      from gp;
93     choix : Integer  from Standard;
94
95 end CurvPointRadInv;