include/opencascade/Law_S.hxx

0001 // Created on: 1993-12-24
0002 // Created by: Jacques GOUSSARD
0003 // Copyright (c) 1993-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 _Law_S_HeaderFile
0018 #define _Law_S_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Law_BSpFunc.hxx>
0024
0025 //! Describes an "S" evolution law.
0026 class Law_S : public Law_BSpFunc
0027 {
0028
0029 public:
0030   //! Constructs an empty "S" evolution law.
0031   Standard_EXPORT Law_S();
0032
0033   //! Defines this S evolution law by assigning both:
0034   //! -   the bounds Pdeb and Pfin of the parameter, and
0035   //! -   the values Valdeb and Valfin of the function at these
0036   //! two parametric bounds.
0037   //! The function is assumed to have the first derivatives
0038   //! equal to 0 at the two parameter points Pdeb and Pfin.
0039   Standard_EXPORT void Set(const double Pdeb,
0040                            const double Valdeb,
0041                            const double Pfin,
0042                            const double Valfin);
0043
0044   //! Defines this S evolution law by assigning
0045   //! -   the bounds Pdeb and Pfin of the parameter,
0046   //! -   the values Valdeb and Valfin of the function at these
0047   //! two parametric bounds, and
0048   //! -   the values Ddeb and Dfin of the first derivative of the
0049   //! function at these two parametric bounds.
0050   Standard_EXPORT void Set(const double Pdeb,
0051                            const double Valdeb,
0052                            const double Ddeb,
0053                            const double Pfin,
0054                            const double Valfin,
0055                            const double Dfin);
0056
0057   DEFINE_STANDARD_RTTIEXT(Law_S, Law_BSpFunc)
0058 };
0059
0060 #endif // _Law_S_HeaderFile