src/Extrema/Extrema_Point.cdl

   1 -- Created on: 1991-02-21
   2 -- Created by: Isabelle GRIGNON
   3 -- Copyright (c) 1991-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 generic class   Point from Extrema  (Pnt as any)
  18         inherits Storable from Standard
  19         ---Purpose: Definition of a point on curve.
  20
  21
  22 is
  23     Create returns Point;
  24         ---Purpose: Creation of an indefinite point on curve.
  25
  26     Create (U: Real; P: Pnt) returns Point;
  27         ---Purpose: Creation of a point on curve with a parameter
  28         --          value on the curve and a Pnt from gp.
  29
  30     SetValues(me: in out; U: Real; P: Pnt)
  31         ---Purpose: sets the point and parameter values.
  32     is static;
  33
  34     Value (me) returns Pnt
  35         ---Purpose: Returns the point.
  36         ---C++: return const&
  37         ---C++: inline
  38         is static;
  39
  40     Parameter (me) returns Real
  41         ---Purpose: Returns the parameter on the curve.
  42         ---C++: inline
  43         is static;
  44
  45 fields
  46     myU: Real;
  47     myP: Pnt;
  48
  49 end Point;