include/opencascade/FairCurve_BattenLaw.hxx

0001 // Created on: 1996-01-26
0002 // Created by: Philippe MANGIN
0003 // Copyright (c) 1996-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _FairCurve_BattenLaw_HeaderFile
0018 #define _FairCurve_BattenLaw_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Real.hxx>
0025 #include <math_Function.hxx>
0026 #include <Standard_Boolean.hxx>
0027
0028 //! This class compute the Heigth of an batten
0029 class FairCurve_BattenLaw : public math_Function
0030 {
0031 public:
0032   DEFINE_STANDARD_ALLOC
0033
0034   //! Constructor of linear batten with
0035   //! Heigth  : the Heigth at the middle point
0036   //! Slope   : the geometric slope of the batten
0037   //! Sliding : Active Length of the batten without extension
0038   Standard_EXPORT FairCurve_BattenLaw(const double Heigth,
0039                                       const double Slope,
0040                                       const double Sliding);
0041
0042   //! Change the value of sliding
0043   void SetSliding(const double Sliding);
0044
0045   //! Change the value of Heigth at the middle point.
0046   void SetHeigth(const double Heigth);
0047
0048   //! Change the value of the geometric slope.
0049   void SetSlope(const double Slope);
0050
0051   //! computes the value of the heigth for the parameter T
0052   //! on the neutral fibber
0053   bool Value(const double T, double& THeigth) override;
0054
0055 private:
0056   double MiddleHeigth;
0057   double GeometricSlope;
0058   double LengthSliding;
0059 };
0060
0061 #include <FairCurve_BattenLaw.lxx>
0062
0063 #endif // _FairCurve_BattenLaw_HeaderFile