include/opencascade/Expr_NumericValue.hxx

0001 // Created on: 1991-01-10
0002 // Created by: Arnaud BOUZY
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 _Expr_NumericValue_HeaderFile
0018 #define _Expr_NumericValue_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Expr_GeneralExpression.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <Expr_Array1OfNamedUnknown.hxx>
0026 #include <TColStd_Array1OfReal.hxx>
0027 class Expr_NamedUnknown;
0028 class TCollection_AsciiString;
0029
0030
0031 class Expr_NumericValue;
0032 DEFINE_STANDARD_HANDLE(Expr_NumericValue, Expr_GeneralExpression)
0033
0034 //! This class describes any reel value defined in an
0035 //! expression.
0036 class Expr_NumericValue : public Expr_GeneralExpression
0037 {
0038
0039 public:
0040
0041
0042   Standard_EXPORT Expr_NumericValue(const Standard_Real val);
0043
0044   Standard_EXPORT Standard_Real GetValue() const;
0045
0046   Standard_EXPORT void SetValue (const Standard_Real val);
0047
0048   //! Returns the number of sub-expressions contained
0049   //! in <me> ( >= 0)
0050   Standard_EXPORT Standard_Integer NbSubExpressions() const Standard_OVERRIDE;
0051
0052   //! Returns the <I>-th sub-expression of <me>
0053   //! raises OutOfRange if <I> > NbSubExpressions(me)
0054   Standard_EXPORT const Handle(Expr_GeneralExpression)& SubExpression (const Standard_Integer I) const Standard_OVERRIDE;
0055
0056   //! Returns a GeneralExpression after replacement of
0057   //! NamedUnknowns by an associated expression and after
0058   //! values computation.
0059   Standard_EXPORT Handle(Expr_GeneralExpression) Simplified() const Standard_OVERRIDE;
0060
0061   //! Returns a GeneralExpression after a simplification
0062   //! of the arguments of <me>.
0063   Standard_EXPORT Handle(Expr_GeneralExpression) ShallowSimplified() const Standard_OVERRIDE;
0064
0065   //! Returns a copy of <me> having the same unknowns and functions.
0066   Standard_EXPORT Handle(Expr_GeneralExpression) Copy() const Standard_OVERRIDE;
0067
0068   //! Tests if <me> contains NamedUnknown.
0069   Standard_EXPORT Standard_Boolean ContainsUnknowns() const Standard_OVERRIDE;
0070
0071   //! Tests if <exp> is contained in <me>.
0072   Standard_EXPORT Standard_Boolean Contains (const Handle(Expr_GeneralExpression)& exp) const Standard_OVERRIDE;
0073
0074   //! Tests if <me> and <Other> define the same expression.
0075   //! This method does not include any simplification before
0076   //! testing.
0077   Standard_EXPORT Standard_Boolean IsIdentical (const Handle(Expr_GeneralExpression)& Other) const Standard_OVERRIDE;
0078
0079   Standard_EXPORT Standard_Boolean IsLinear() const Standard_OVERRIDE;
0080
0081   //! Returns the derivative on <X> unknown of <me>
0082   Standard_EXPORT Handle(Expr_GeneralExpression) Derivative (const Handle(Expr_NamedUnknown)& X) const Standard_OVERRIDE;
0083
0084   //! Returns the <N>-th derivative on <X> unknown of <me>.
0085   //! Raises OutOfRange if <N> <= 0
0086   Standard_EXPORT virtual Handle(Expr_GeneralExpression) NDerivative (const Handle(Expr_NamedUnknown)& X, const Standard_Integer N) const Standard_OVERRIDE;
0087
0088   //! Replaces all occurrences of <var> with <with> in <me>
0089   Standard_EXPORT void Replace (const Handle(Expr_NamedUnknown)& var, const Handle(Expr_GeneralExpression)& with) Standard_OVERRIDE;
0090
0091   //! Returns the value of <me> (as a Real) by
0092   //! replacement of <vars> by <vals>.
0093   Standard_EXPORT Standard_Real Evaluate (const Expr_Array1OfNamedUnknown& vars, const TColStd_Array1OfReal& vals) const Standard_OVERRIDE;
0094
0095   //! returns a string representing <me> in a readable way.
0096   Standard_EXPORT TCollection_AsciiString String() const Standard_OVERRIDE;
0097
0098
0099
0100
0101   DEFINE_STANDARD_RTTIEXT(Expr_NumericValue,Expr_GeneralExpression)
0102
0103 protected:
0104
0105
0106
0107
0108 private:
0109
0110
0111   Standard_Real myValue;
0112
0113
0114 };
0115
0116
0117
0118
0119
0120
0121
0122 #endif // _Expr_NumericValue_HeaderFile