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