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
0027 //! This class gives a default sample (constant difference
0028 //! of parameter) for a function defined between
0029 //! two bound A,B.
0030 class math_FunctionSample
0031 {
0032 public:
0033
0034   DEFINE_STANDARD_ALLOC
0035
0036
0037   Standard_EXPORT math_FunctionSample(const Standard_Real A, const Standard_Real B, const Standard_Integer N);
0038
0039   //! Returns the bounds of parameters.
0040   Standard_EXPORT virtual void Bounds (Standard_Real& A, Standard_Real& B) const;
0041
0042   //! Returns the number of sample points.
0043   Standard_EXPORT Standard_Integer NbPoints() const;
0044
0045   //! Returns the value of parameter of the point of
0046   //! range Index : A + ((Index-1)/(NbPoints-1))*B.
0047   //! An exception is raised if Index<=0 or Index>NbPoints.
0048   Standard_EXPORT virtual Standard_Real GetParameter (const Standard_Integer Index) const;
0049
0050
0051
0052
0053 protected:
0054
0055
0056
0057
0058
0059 private:
0060
0061
0062
0063   Standard_Real a;
0064   Standard_Real b;
0065   Standard_Integer n;
0066
0067
0068 };
0069
0070
0071
0072
0073
0074
0075
0076 #endif // _math_FunctionSample_HeaderFile