0024428: Implementation of LGPL license
[occt.git] / src / AppCont / AppCont_FunctionTool.cdl
1 -- Created on: 1993-09-01
2 -- Created by: Laurent PAINNOT
3 -- Copyright (c) 1993-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
9 -- under the terms of the GNU Lesser General Public 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 FunctionTool from AppCont
18
19
20 uses Function        from AppCont,
21      Pnt             from gp,
22      Pnt2d           from gp,
23      Vec             from gp,
24      Vec2d           from gp,
25      Array1OfPnt     from TColgp,
26      Array1OfPnt2d   from TColgp,
27      Array1OfVec     from TColgp,
28      Array1OfVec2d   from TColgp
29
30 is
31     
32     FirstParameter(myclass; C: Function from AppCont) returns Real;
33         ---Purpose: returns the first parameter of the Function.
34
35     LastParameter(myclass; C: Function from AppCont) returns Real;
36         ---Purpose: returns the last parameter of the Function.
37
38     NbP2d(myclass; C: Function from AppCont) returns Integer;
39         ---Purpose: Returns 0.
40
41
42     NbP3d(myclass; C: Function from AppCont) returns Integer;
43         ---Purpose: Returns 1. (the approximation will be done only for one 
44         --          function.
45
46
47     Value(myclass; C: Function from AppCont; U: Real; tabPt: out Array1OfPnt);
48         ---Purpose: <tabP> is an array of only 1 element, the point value at
49         --          the parameter <U>.
50
51
52     D1(myclass; C: Function from AppCont; U: Real; tabV: out Array1OfVec)
53     returns Boolean;
54         ---Purpose: <tabV> is an array of only 1 element, the derivative 
55         --          value at the parameter <U>.
56
57
58     ----------------------------------------------------------
59     -- the following methods won t be called by the algorithms
60     -- but the description must exist in the tool.
61     ----------------------------------------------------------
62
63
64
65     Value(myclass; C: Function from AppCont;U: Real; 
66           tabPt2d: out Array1OfPnt2d);
67     
68     Value(myclass; C: Function from AppCont; U: Real; 
69           tabPt: out Array1OfPnt;
70           tabPt2d: out Array1OfPnt2d);
71
72
73     D1(myclass;C: Function from AppCont;U: Real; 
74              tabV2d: out Array1OfVec2d)
75     returns Boolean;
76
77
78     D1(myclass; C: Function from AppCont; U: Real; 
79              tabV: out Array1OfVec;
80              tabV2d: out Array1OfVec2d)
81     returns Boolean;
82
83
84 end FunctionTool;    
85