src/Geom2dGcc/Geom2dGcc_FunctionTanCirCu.hxx

   1 // Created on: 1992-02-20
   2 // Created by: Remy GILET
   3 // Copyright (c) 1992-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 #ifndef _Geom2dGcc_FunctionTanCirCu_HeaderFile
  18 #define _Geom2dGcc_FunctionTanCirCu_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <gp_Circ2d.hxx>
  25 #include <Geom2dAdaptor_Curve.hxx>
  26 #include <Standard_Real.hxx>
  27 #include <math_FunctionWithDerivative.hxx>
  28 #include <Standard_Boolean.hxx>
  29 class gp_Circ2d;
  30 class Geom2dAdaptor_Curve;
  31
  32
  33 //! This abstract class describes a Function of 1 Variable
  34 //! used to find a line tangent to a curve and a circle.
  35 class Geom2dGcc_FunctionTanCirCu  : public math_FunctionWithDerivative
  36 {
  37 public:
  38
  39   DEFINE_STANDARD_ALLOC
  40
  41
  42   Standard_EXPORT Geom2dGcc_FunctionTanCirCu(const gp_Circ2d& Circ, const Geom2dAdaptor_Curve& Curv);
  43
  44   //! Computes the value of the function F for the variable X.
  45   //! It returns True if the computation is successfully done,
  46   //! False otherwise.
  47   Standard_EXPORT Standard_Boolean Value (const Standard_Real X, Standard_Real& F);
  48
  49   //! Computes the derivative of the function F for the variable X.
  50   //! It returns True if the computation is successfully done,
  51   //! False otherwise.
  52   Standard_EXPORT Standard_Boolean Derivative (const Standard_Real X, Standard_Real& Deriv);
  53
  54   //! Computes the value and the derivative of the function F
  55   //! for the variable X.
  56   //! It returns True if the computation is successfully done,
  57   //! False otherwise.
  58   Standard_EXPORT Standard_Boolean Values (const Standard_Real X, Standard_Real& F, Standard_Real& Deriv);
  59
  60
  61
  62
  63 protected:
  64
  65
  66
  67
  68
  69 private:
  70
  71
  72
  73   gp_Circ2d TheCirc;
  74   Geom2dAdaptor_Curve Curve;
  75   Standard_Real myWeight;
  76
  77
  78 };
  79
  80
  81
  82
  83
  84
  85
  86 #endif // _Geom2dGcc_FunctionTanCirCu_HeaderFile