src/Law/Law_Function.hxx

   1 // Created on: 1993-12-24
   2 // Created by: Jacques GOUSSARD
   3 // Copyright (c) 1993-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 _Law_Function_HeaderFile
  18 #define _Law_Function_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Transient.hxx>
  24 #include <GeomAbs_Shape.hxx>
  25 #include <Standard_Integer.hxx>
  26 #include <TColStd_Array1OfReal.hxx>
  27 #include <Standard_Real.hxx>
  28 class Standard_OutOfRange;
  29
  30
  31 class Law_Function;
  32 DEFINE_STANDARD_HANDLE(Law_Function, Standard_Transient)
  33
  34 //! Root class for evolution laws.
  35 class Law_Function : public Standard_Transient
  36 {
  37
  38 public:
  39
  40
  41   Standard_EXPORT virtual GeomAbs_Shape Continuity() const = 0;
  42
  43   //! Returns  the number  of  intervals for  continuity
  44   //! <S>. May be one if Continuity(me) >= <S>
  45   Standard_EXPORT virtual Standard_Integer NbIntervals (const GeomAbs_Shape S) const = 0;
  46
  47   //! Stores in <T> the  parameters bounding the intervals
  48   //! of continuity <S>.
  49   //!
  50   //! The array must provide  enough room to  accomodate
  51   //! for the parameters. i.e. T.Length() > NbIntervals()
  52   Standard_EXPORT virtual void Intervals (TColStd_Array1OfReal& T, const GeomAbs_Shape S) const = 0;
  53
  54   //! Returns the value of the function at the point of parameter X.
  55   Standard_EXPORT virtual Standard_Real Value (const Standard_Real X) = 0;
  56
  57   //! Returns the value F and the first derivative D of the
  58   //! function at the point of parameter X.
  59   Standard_EXPORT virtual void D1 (const Standard_Real X, Standard_Real& F, Standard_Real& D) = 0;
  60
  61   //! Returns the value, first and seconde derivatives
  62   //! at parameter X.
  63   Standard_EXPORT virtual void D2 (const Standard_Real X, Standard_Real& F, Standard_Real& D, Standard_Real& D2) = 0;
  64
  65   //! Returns a  law equivalent of  <me>  between
  66   //! parameters <First>  and <Last>. <Tol>  is used  to
  67   //! test for 3d points confusion.
  68   //! It is usfule to determines the derivatives
  69   //! in these values <First> and <Last> if
  70   //! the Law is not Cn.
  71   Standard_EXPORT virtual Handle(Law_Function) Trim (const Standard_Real PFirst, const Standard_Real PLast, const Standard_Real Tol) const = 0;
  72
  73   //! Returns the parametric bounds of the function.
  74   Standard_EXPORT virtual void Bounds (Standard_Real& PFirst, Standard_Real& PLast) = 0;
  75
  76
  77
  78
  79   DEFINE_STANDARD_RTTIEXT(Law_Function,Standard_Transient)
  80
  81 protected:
  82
  83
  84
  85
  86 private:
  87
  88
  89
  90
  91 };
  92
  93
  94
  95
  96
  97
  98
  99 #endif // _Law_Function_HeaderFile