include/opencascade/Expr_PolyExpression.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_PolyExpression_HeaderFile
0018 #define _Expr_PolyExpression_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Expr_SequenceOfGeneralExpression.hxx>
0024 #include <Expr_GeneralExpression.hxx>
0025 #include <Standard_Integer.hxx>
0026 class Expr_NamedUnknown;
0027
0028
0029 class Expr_PolyExpression;
0030 DEFINE_STANDARD_HANDLE(Expr_PolyExpression, Expr_GeneralExpression)
0031
0032
0033 class Expr_PolyExpression : public Expr_GeneralExpression
0034 {
0035
0036 public:
0037
0038
0039   //! returns the number of operands contained in <me>
0040   Standard_EXPORT Standard_Integer NbOperands() const;
0041
0042   //! Returns the <index>-th operand used in <me>.
0043   //! An exception is raised if index is out of range
0044     const Handle(Expr_GeneralExpression)& Operand (const Standard_Integer index) const;
0045
0046   //! Sets the <index>-th operand used in <me>.
0047   //! An exception is raised if <index> is out of range
0048   //! Raises InvalidOperand if <exp> contains <me>.
0049   Standard_EXPORT void SetOperand (const Handle(Expr_GeneralExpression)& exp, const Standard_Integer index);
0050
0051   //! returns the number of sub-expressions contained
0052   //! in <me> ( >= 2)
0053   Standard_EXPORT Standard_Integer NbSubExpressions() const Standard_OVERRIDE;
0054
0055   //! Returns the sub-expression denoted by <I> in <me>
0056   //! Raises OutOfRange if <I> > NbSubExpressions(me)
0057   Standard_EXPORT const Handle(Expr_GeneralExpression)& SubExpression (const Standard_Integer I) const Standard_OVERRIDE;
0058
0059   //! Does <me> contains NamedUnknown ?
0060   Standard_EXPORT Standard_Boolean ContainsUnknowns() const Standard_OVERRIDE;
0061
0062   //! Tests if <exp> is contained in <me>.
0063   Standard_EXPORT Standard_Boolean Contains (const Handle(Expr_GeneralExpression)& exp) const Standard_OVERRIDE;
0064
0065   //! Replaces all occurrences of <var> with <with> in <me>
0066   //! Raises InvalidOperand if <with> contains <me>.
0067   Standard_EXPORT void Replace (const Handle(Expr_NamedUnknown)& var, const Handle(Expr_GeneralExpression)& with) Standard_OVERRIDE;
0068
0069   //! Returns a GeneralExpression after replacement of
0070   //! NamedUnknowns by an associated expression and after
0071   //! values computation.
0072   Standard_EXPORT Handle(Expr_GeneralExpression) Simplified() const Standard_OVERRIDE;
0073
0074
0075
0076
0077   DEFINE_STANDARD_RTTIEXT(Expr_PolyExpression,Expr_GeneralExpression)
0078
0079 protected:
0080
0081
0082   //! initialize an empty list of operands.
0083   Standard_EXPORT Expr_PolyExpression();
0084
0085   //! Adds an operand to the list of <me>.
0086   Standard_EXPORT void AddOperand (const Handle(Expr_GeneralExpression)& exp);
0087
0088   //! Remove the operand denoted by <index> from the list of
0089   //! <me>.
0090   //! Raises exception if <index> is out of range or if
0091   //! removing operand intend to leave only one or no
0092   //! operand.
0093   Standard_EXPORT void RemoveOperand (const Standard_Integer index);
0094
0095
0096
0097 private:
0098
0099
0100   Expr_SequenceOfGeneralExpression myOperands;
0101
0102
0103 };
0104
0105
0106 #include <Expr_PolyExpression.lxx>
0107
0108
0109
0110
0111
0112 #endif // _Expr_PolyExpression_HeaderFile