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-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
  21
  22
  23 class FunctionTool from AppCont
  24
  25
  26 uses Function        from AppCont,
  27      Pnt             from gp,
  28      Pnt2d           from gp,
  29      Vec             from gp,
  30      Vec2d           from gp,
  31      Array1OfPnt     from TColgp,
  32      Array1OfPnt2d   from TColgp,
  33      Array1OfVec     from TColgp,
  34      Array1OfVec2d   from TColgp
  35
  36 is
  37
  38     FirstParameter(myclass; C: Function from AppCont) returns Real;
  39         ---Purpose: returns the first parameter of the Function.
  40
  41     LastParameter(myclass; C: Function from AppCont) returns Real;
  42         ---Purpose: returns the last parameter of the Function.
  43
  44     NbP2d(myclass; C: Function from AppCont) returns Integer;
  45         ---Purpose: Returns 0.
  46
  47
  48     NbP3d(myclass; C: Function from AppCont) returns Integer;
  49         ---Purpose: Returns 1. (the approximation will be done only for one
  50         --          function.
  51
  52
  53     Value(myclass; C: Function from AppCont; U: Real; tabPt: out Array1OfPnt);
  54         ---Purpose: <tabP> is an array of only 1 element, the point value at
  55         --          the parameter <U>.
  56
  57
  58     D1(myclass; C: Function from AppCont; U: Real; tabV: out Array1OfVec)
  59     returns Boolean;
  60         ---Purpose: <tabV> is an array of only 1 element, the derivative
  61         --          value at the parameter <U>.
  62
  63
  64     ----------------------------------------------------------
  65     -- the following methods won t be called by the algorithms
  66     -- but the description must exist in the tool.
  67     ----------------------------------------------------------
  68
  69
  70
  71     Value(myclass; C: Function from AppCont;U: Real;
  72           tabPt2d: out Array1OfPnt2d);
  73
  74     Value(myclass; C: Function from AppCont; U: Real;
  75           tabPt: out Array1OfPnt;
  76           tabPt2d: out Array1OfPnt2d);
  77
  78
  79     D1(myclass;C: Function from AppCont;U: Real;
  80              tabV2d: out Array1OfVec2d)
  81     returns Boolean;
  82
  83
  84     D1(myclass; C: Function from AppCont; U: Real;
  85              tabV: out Array1OfVec;
  86              tabV2d: out Array1OfVec2d)
  87     returns Boolean;
  88
  89
  90 end FunctionTool;
  91