include/opencascade/math_FunctionSample.hxx

0001 // Created on: 1991-07-17
0002 // Created by: Isabelle GRIGNON
0003 // Copyright (c) 1991-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 _math_FunctionSample_HeaderFile
0018 #define _math_FunctionSample_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Real.hxx>
0025
0026 //! This class gives a default sample (constant difference
0027 //! of parameter) for a function defined between
0028 //! two bound A,B.
0029 class math_FunctionSample
0030 {
0031 public:
0032   DEFINE_STANDARD_ALLOC
0033
0034   Standard_EXPORT math_FunctionSample(const Standard_Real    A,
0035                                       const Standard_Real    B,
0036                                       const Standard_Integer N);
0037
0038   //! Returns the bounds of parameters.
0039   Standard_EXPORT virtual void Bounds(Standard_Real& A, Standard_Real& B) const;
0040
0041   //! Returns the number of sample points.
0042   Standard_EXPORT Standard_Integer NbPoints() const;
0043
0044   //! Returns the value of parameter of the point of
0045   //! range Index : A + ((Index-1)/(NbPoints-1))*B.
0046   //! An exception is raised if Index<=0 or Index>NbPoints.
0047   Standard_EXPORT virtual Standard_Real GetParameter(const Standard_Integer Index) const;
0048
0049 protected:
0050 private:
0051   Standard_Real    a;
0052   Standard_Real    b;
0053   Standard_Integer n;
0054 };
0055
0056 #endif // _math_FunctionSample_HeaderFile