0023024: Update headers of OCCT files
[occt.git] / src / BRepBlend / BRepBlend_SurfCurvEvolRadInv.cdl
CommitLineData
b311480e 1-- Created on: 1997-07-29
2-- Created by: Jerome LEMONIER
3-- Copyright (c) 1997-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
7fd59977 21
22class SurfCurvEvolRadInv from BRepBlend
23
24inherits SurfCurvFuncInv from Blend
25
26 ---Purpose: Class used to compute a solution of the
27 -- surfRstConstRad problem on a done restriction of the
28 -- surface.
29 -- The vector <X> used in Value, Values and Derivatives
30 -- methods has to be the vector of the parametric
31 -- coordinates wguide, wcurv, wrst where wguide is the
32 -- parameter on the guide line, wcurv is the parameter on
33 -- the curve, wrst is the parameter on the restriction on
34 -- the surface.
35
36uses
37 HCurve2d from Adaptor2d,
38 HCurve from Adaptor3d,
39 HSurface from Adaptor3d,
40 Vector from math,
41 Matrix from math,
42 Function from Law
43
44
45is
46
47 Create(S : HSurface from Adaptor3d;
48 C : HCurve from Adaptor3d;
49 Cg : HCurve from Adaptor3d;
50 Evol : Function from Law)
51 returns SurfCurvEvolRadInv from BRepBlend;
52
53 Set(me: in out;Choix: Integer from Standard)
54 is static;
55
56 NbEquations(me)
57 ---Purpose: returns 3.
58 returns Integer from Standard;
59
60 Value(me: in out; X: Vector; F: out Vector)
61 ---Purpose: computes the values <F> of the Functions for the
62 -- variable <X>.
63 -- Returns True if the computation was done successfully,
64 -- False otherwise.
65 returns Boolean from Standard;
66
67 Derivatives(me: in out; X: Vector; D: out Matrix)
68 ---Purpose: returns the values <D> of the derivatives for the
69 -- variable <X>.
70 -- Returns True if the computation was done successfully,
71 -- False otherwise.
72 returns Boolean from Standard;
73
74 Values(me: in out; X: Vector; F: out Vector; D: out Matrix)
75 ---Purpose: returns the values <F> of the functions and the derivatives
76 -- <D> for the variable <X>.
77 -- Returns True if the computation was done successfully,
78 -- False otherwise.
79 returns Boolean from Standard;
80
81 Set(me: in out; Rst : HCurve2d from Adaptor2d);
82 ---Purpose: Set the restriction on which a solution has to be found.
83
84 GetTolerance(me; Tolerance: out Vector from math; Tol: Real from Standard);
85 ---Purpose: Returns in the vector Tolerance the parametric tolerance
86 -- for each of the 3 variables;
87 -- Tol is the tolerance used in 3d space.
88
89 GetBounds(me; InfBound,SupBound: out Vector from math);
90 ---Purpose: Returns in the vector InfBound the lowest values allowed
91 -- for each of the 3 variables.
92 -- Returns in the vector SupBound the greatest values allowed
93 -- for each of the 3 variables.
94
95 IsSolution(me: in out; Sol: Vector from math; Tol: Real from Standard)
96 ---Purpose: Returns Standard_True if Sol is a zero of the function.
97 -- Tol is the tolerance used in 3d space.
98 returns Boolean from Standard;
99
100fields
101
102 surf : HSurface from Adaptor3d;
103 curv : HCurve from Adaptor3d;
104 guide : HCurve from Adaptor3d;
105 rst : HCurve2d from Adaptor2d;
106 ray : Real from Standard;
107 choix : Integer from Standard;
108 tevol : Function from Law;
109 sg1 : Real from Standard;
110
111
112end SurfCurvEvolRadInv;
113
114