0024710: Avoid including Handle_Class.hxx headers except where necessary
[occt.git] / src / ProjLib / ProjLib_PrjFunc.cdl
CommitLineData
b311480e 1-- Created on: 1997-11-06
2-- Created by: Roman BORISOV
3-- Copyright (c) 1997-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
d5f74e42 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
973c2be1 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.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17private class PrjFunc from ProjLib inherits FunctionSetWithDerivatives from math
18
19 ---Purpose:
20
21uses
22 Vector from math,
23 Matrix from math,
24 CurvePtr from Adaptor3d,
25 SurfacePtr from Adaptor3d,
26 Pnt2d from gp
27
28raises ConstructionError
29
30is
31 Create (C: CurvePtr from Adaptor3d; FixVal: Real from Standard; S: SurfacePtr from Adaptor3d; Fix: Integer)
32 returns PrjFunc
33 raises ConstructionError;
34
35 NbVariables(me)
36 ---Purpose: returns the number of variables of the function.
37
38 returns Integer;
39
40 NbEquations(me)
41 ---Purpose: returns the number of equations of the function.
42
43 returns Integer;
44
45 Value(me: in out; X: Vector from math; F: out Vector from math)
46 ---Purpose: computes the values <F> of the Functions for the
47 -- variable <X>.
48 -- Returns True if the computation was done successfully,
49 -- False otherwise.
50
51 returns Boolean;
52
53 Derivatives(me: in out; X: Vector from math; D: out Matrix from math)
54 ---Purpose: returns the values <D> of the derivatives for the
55 -- variable <X>.
56 -- Returns True if the computation was done successfully,
57 -- False otherwise.
58
59 returns Boolean;
60
61 Values(me: in out; X: Vector from math; F: out Vector from math; D: out Matrix from math)
62 ---Purpose: returns the values <F> of the functions and the derivatives
63 -- <D> for the variable <X>.
64 -- Returns True if the computation was done successfully,
65 -- False otherwise.
66
67 returns Boolean;
68
69 Solution(me) returns Pnt2d from gp;
70 ---Purpose: returns point on surface
71
72fields
73
74 myCurve : CurvePtr from Adaptor3d;
75 mySurface : SurfacePtr from Adaptor3d;
76 myt : Real from Standard;
77 myU, myV : Real from Standard;
78 myFix : Integer from Standard;
79 myNorm : Real from Standard;
80end PrjFunc;