src/Expr/Expr_NumericValue.hxx

   1 // Created on: 1991-01-10
   2 // Created by: Arnaud BOUZY
   3 // Copyright (c) 1991-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 _Expr_NumericValue_HeaderFile
  18 #define _Expr_NumericValue_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Real.hxx>
  24 #include <Expr_GeneralExpression.hxx>
  25 #include <Standard_Integer.hxx>
  26 #include <Standard_Boolean.hxx>
  27 #include <Expr_Array1OfNamedUnknown.hxx>
  28 #include <TColStd_Array1OfReal.hxx>
  29 class Standard_OutOfRange;
  30 class Expr_GeneralExpression;
  31 class Expr_NamedUnknown;
  32 class TCollection_AsciiString;
  33
  34
  35 class Expr_NumericValue;
  36 DEFINE_STANDARD_HANDLE(Expr_NumericValue, Expr_GeneralExpression)
  37
  38 //! This class describes any reel value defined in an
  39 //! expression.
  40 class Expr_NumericValue : public Expr_GeneralExpression
  41 {
  42
  43 public:
  44
  45
  46   Standard_EXPORT Expr_NumericValue(const Standard_Real val);
  47
  48   Standard_EXPORT Standard_Real GetValue() const;
  49
  50   Standard_EXPORT void SetValue (const Standard_Real val);
  51
  52   //! Returns the number of sub-expressions contained
  53   //! in <me> ( >= 0)
  54   Standard_EXPORT Standard_Integer NbSubExpressions() const Standard_OVERRIDE;
  55
  56   //! Returns the <I>-th sub-expression of <me>
  57   //! raises OutOfRange if <I> > NbSubExpressions(me)
  58   Standard_EXPORT const Handle(Expr_GeneralExpression)& SubExpression (const Standard_Integer I) const Standard_OVERRIDE;
  59
  60   //! Returns a GeneralExpression after replacement of
  61   //! NamedUnknowns by an associated expression and after
  62   //! values computation.
  63   Standard_EXPORT Handle(Expr_GeneralExpression) Simplified() const Standard_OVERRIDE;
  64
  65   //! Returns a GeneralExpression after a simplification
  66   //! of the arguments of <me>.
  67   Standard_EXPORT Handle(Expr_GeneralExpression) ShallowSimplified() const Standard_OVERRIDE;
  68
  69   //! Returns a copy of <me> having the same unknowns and functions.
  70   Standard_EXPORT Handle(Expr_GeneralExpression) Copy() const Standard_OVERRIDE;
  71
  72   //! Tests if <me> contains NamedUnknown.
  73   Standard_EXPORT Standard_Boolean ContainsUnknowns() const Standard_OVERRIDE;
  74
  75   //! Tests if <exp> is contained in <me>.
  76   Standard_EXPORT Standard_Boolean Contains (const Handle(Expr_GeneralExpression)& exp) const Standard_OVERRIDE;
  77
  78   //! Tests if <me> and <Other> define the same expression.
  79   //! This method does not include any simplification before
  80   //! testing.
  81   Standard_EXPORT Standard_Boolean IsIdentical (const Handle(Expr_GeneralExpression)& Other) const Standard_OVERRIDE;
  82
  83   Standard_EXPORT Standard_Boolean IsLinear() const Standard_OVERRIDE;
  84
  85   //! Returns the derivative on <X> unknown of <me>
  86   Standard_EXPORT Handle(Expr_GeneralExpression) Derivative (const Handle(Expr_NamedUnknown)& X) const Standard_OVERRIDE;
  87
  88   //! Returns the <N>-th derivative on <X> unknown of <me>.
  89   //! Raises OutOfRange if <N> <= 0
  90   Standard_EXPORT virtual Handle(Expr_GeneralExpression) NDerivative (const Handle(Expr_NamedUnknown)& X, const Standard_Integer N) const Standard_OVERRIDE;
  91
  92   //! Replaces all occurences of <var> with <with> in <me>
  93   Standard_EXPORT void Replace (const Handle(Expr_NamedUnknown)& var, const Handle(Expr_GeneralExpression)& with) Standard_OVERRIDE;
  94
  95   //! Returns the value of <me> (as a Real) by
  96   //! replacement of <vars> by <vals>.
  97   Standard_EXPORT Standard_Real Evaluate (const Expr_Array1OfNamedUnknown& vars, const TColStd_Array1OfReal& vals) const Standard_OVERRIDE;
  98
  99   //! returns a string representing <me> in a readable way.
 100   Standard_EXPORT TCollection_AsciiString String() const Standard_OVERRIDE;
 101
 102
 103
 104
 105   DEFINE_STANDARD_RTTIEXT(Expr_NumericValue,Expr_GeneralExpression)
 106
 107 protected:
 108
 109
 110
 111
 112 private:
 113
 114
 115   Standard_Real myValue;
 116
 117
 118 };
 119
 120
 121
 122
 123
 124
 125
 126 #endif // _Expr_NumericValue_HeaderFile