include/opencascade/Expr_NamedConstant.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_NamedConstant_HeaderFile
0018 #define _Expr_NamedConstant_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Expr_NamedExpression.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <Expr_Array1OfNamedUnknown.hxx>
0026 #include <TColStd_Array1OfReal.hxx>
0027 class TCollection_AsciiString;
0028 class Expr_GeneralExpression;
0029 class Expr_NamedUnknown;
0030
0031
0032 class Expr_NamedConstant;
0033 DEFINE_STANDARD_HANDLE(Expr_NamedConstant, Expr_NamedExpression)
0034
0035 //! Describes any numeric constant known by a special name
0036 //! (as PI, e,...).
0037 class Expr_NamedConstant : public Expr_NamedExpression
0038 {
0039
0040 public:
0041
0042
0043   //! Creates a constant value of name <name> and value <value>.
0044   Standard_EXPORT Expr_NamedConstant(const TCollection_AsciiString& name, const Standard_Real value);
0045
0046     Standard_Real GetValue() const;
0047
0048   //! returns the number of sub-expressions contained
0049   //! in <me> (always returns zero)
0050   Standard_EXPORT Standard_Integer NbSubExpressions() const Standard_OVERRIDE;
0051
0052   //! returns the <I>-th sub-expression of <me>
0053   //! raises OutOfRange
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   //! (returns always False)
0070   Standard_EXPORT Standard_Boolean ContainsUnknowns() const Standard_OVERRIDE;
0071
0072   //! Tests if <exp> is contained in <me>.
0073   Standard_EXPORT Standard_Boolean Contains (const Handle(Expr_GeneralExpression)& exp) const Standard_OVERRIDE;
0074
0075   Standard_EXPORT Standard_Boolean IsLinear() const Standard_OVERRIDE;
0076
0077   //! Returns the derivative on <X> unknown of <me>
0078   Standard_EXPORT Handle(Expr_GeneralExpression) Derivative (const Handle(Expr_NamedUnknown)& X) const Standard_OVERRIDE;
0079
0080   //! Returns the <N>-th derivative on <X> unknown of <me>.
0081   //! Raises OutOfRange if <N> <= 0
0082   Standard_EXPORT virtual Handle(Expr_GeneralExpression) NDerivative (const Handle(Expr_NamedUnknown)& X, const Standard_Integer N) const Standard_OVERRIDE;
0083
0084   //! Replaces all occurrences of <var> with <with> in <me>
0085   Standard_EXPORT void Replace (const Handle(Expr_NamedUnknown)& var, const Handle(Expr_GeneralExpression)& with) Standard_OVERRIDE;
0086
0087   //! Returns the value of <me> (as a Real) by
0088   //! replacement of <vars> by <vals>.
0089   Standard_EXPORT Standard_Real Evaluate (const Expr_Array1OfNamedUnknown& vars, const TColStd_Array1OfReal& vals) const Standard_OVERRIDE;
0090
0091
0092
0093
0094   DEFINE_STANDARD_RTTIEXT(Expr_NamedConstant,Expr_NamedExpression)
0095
0096 protected:
0097
0098
0099
0100
0101 private:
0102
0103
0104   Standard_Real myValue;
0105
0106
0107 };
0108
0109
0110 #include <Expr_NamedConstant.lxx>
0111
0112
0113
0114
0115
0116 #endif // _Expr_NamedConstant_HeaderFile