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