include/opencascade/Expr_NamedUnknown.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_NamedUnknown_HeaderFile
0018 #define _Expr_NamedUnknown_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 Expr_GeneralExpression;
0028 class TCollection_AsciiString;
0029
0030
0031 class Expr_NamedUnknown;
0032 DEFINE_STANDARD_HANDLE(Expr_NamedUnknown, Expr_NamedExpression)
0033
0034 //! This class describes any variable of an expression.
0035 //! Assignment is treated directly in this class.
0036 class Expr_NamedUnknown : public Expr_NamedExpression
0037 {
0038
0039 public:
0040
0041
0042   Standard_EXPORT Expr_NamedUnknown(const TCollection_AsciiString& name);
0043
0044   //! Tests if an expression is assigned to <me>.
0045     Standard_Boolean IsAssigned() const;
0046
0047   //! If exists, returns the assigned expression.
0048   //! An exception is raised if the expression does not exist.
0049   Standard_EXPORT const Handle(Expr_GeneralExpression)& AssignedExpression() const;
0050
0051   //! Assigns <me> to <exp> expression.
0052   //! Raises exception if <exp> refers to <me>.
0053   Standard_EXPORT void Assign (const Handle(Expr_GeneralExpression)& exp);
0054
0055   //! Suppresses the assigned expression
0056     void Deassign();
0057
0058   //! Returns the number of sub-expressions contained
0059   //! in <me> ( >= 0)
0060   Standard_EXPORT Standard_Integer NbSubExpressions() const Standard_OVERRIDE;
0061
0062   //! Returns the <I>-th sub-expression of <me>
0063   //! raises OutOfRange if <I> > NbSubExpressions(me)
0064   Standard_EXPORT const Handle(Expr_GeneralExpression)& SubExpression (const Standard_Integer I) const Standard_OVERRIDE;
0065
0066   //! Returns a GeneralExpression after replacement of
0067   //! NamedUnknowns by an associated expression and after
0068   //! values computation.
0069   Standard_EXPORT Handle(Expr_GeneralExpression) Simplified() const Standard_OVERRIDE;
0070
0071   //! Returns a GeneralExpression after a simplification
0072   //! of the arguments of <me>.
0073   Standard_EXPORT Handle(Expr_GeneralExpression) ShallowSimplified() const Standard_OVERRIDE;
0074
0075   //! Returns a copy of <me> having the same unknowns and functions.
0076   Standard_EXPORT Handle(Expr_GeneralExpression) Copy() const Standard_OVERRIDE;
0077
0078   //! Tests if <me> contains NamedUnknown.
0079   Standard_EXPORT Standard_Boolean ContainsUnknowns() const Standard_OVERRIDE;
0080
0081   //! Tests if <exp> is contained in <me>.
0082   Standard_EXPORT Standard_Boolean Contains (const Handle(Expr_GeneralExpression)& exp) const Standard_OVERRIDE;
0083
0084   Standard_EXPORT Standard_Boolean IsLinear() const Standard_OVERRIDE;
0085
0086   //! Returns the derivative on <X> unknown of <me>
0087   Standard_EXPORT Handle(Expr_GeneralExpression) Derivative (const Handle(Expr_NamedUnknown)& X) const Standard_OVERRIDE;
0088
0089   //! Replaces all occurrences of <var> with <with> in <me>
0090   //! Raises InvalidOperand if <with> contains <me>.
0091   Standard_EXPORT void Replace (const Handle(Expr_NamedUnknown)& var, const Handle(Expr_GeneralExpression)& with) Standard_OVERRIDE;
0092
0093   //! Returns the value of <me> (as a Real) by
0094   //! replacement of <vars> by <vals>.
0095   //! Raises NotEvaluable if <me> contains NamedUnknown not
0096   //! in <vars> or NumericError if result cannot be computed.
0097   Standard_EXPORT Standard_Real Evaluate (const Expr_Array1OfNamedUnknown& vars, const TColStd_Array1OfReal& vals) const Standard_OVERRIDE;
0098
0099
0100
0101
0102   DEFINE_STANDARD_RTTIEXT(Expr_NamedUnknown,Expr_NamedExpression)
0103
0104 protected:
0105
0106
0107
0108
0109 private:
0110
0111
0112   Handle(Expr_GeneralExpression) myExpression;
0113
0114
0115 };
0116
0117
0118 #include <Expr_NamedUnknown.lxx>
0119
0120
0121
0122
0123
0124 #endif // _Expr_NamedUnknown_HeaderFile