include/opencascade/Expr_GeneralRelation.hxx

0001 // Created on: 1991-01-14
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_GeneralRelation_HeaderFile
0018 #define _Expr_GeneralRelation_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Transient.hxx>
0024 #include <Standard_Integer.hxx>
0025 class Expr_GeneralExpression;
0026 class Expr_NamedUnknown;
0027 class TCollection_AsciiString;
0028
0029 //! Defines the general purposes of any relation between
0030 //! expressions.
0031 class Expr_GeneralRelation : public Standard_Transient
0032 {
0033
0034 public:
0035   //! Returns the current status of the relation
0036   Standard_EXPORT virtual bool IsSatisfied() const = 0;
0037
0038   //! Tests if <me> is linear between its NamedUnknowns.
0039   Standard_EXPORT virtual bool IsLinear() const = 0;
0040
0041   //! Returns a GeneralRelation after replacement of
0042   //! NamedUnknowns by an associated expression, and after
0043   //! values computation.
0044   Standard_EXPORT virtual occ::handle<Expr_GeneralRelation> Simplified() const = 0;
0045
0046   //! Replaces NamedUnknowns by associated expressions,
0047   //! and computes values in <me>.
0048   Standard_EXPORT virtual void Simplify() = 0;
0049
0050   //! Returns a copy of <me> having the same unknowns and
0051   //! functions.
0052   Standard_EXPORT virtual occ::handle<Expr_GeneralRelation> Copy() const = 0;
0053
0054   //! Returns the number of relations contained in <me>.
0055   Standard_EXPORT virtual int NbOfSubRelations() const = 0;
0056
0057   //! Returns the number of SingleRelations contained in
0058   //! <me>.
0059   Standard_EXPORT virtual int NbOfSingleRelations() const = 0;
0060
0061   //! Returns the relation denoted by <index> in <me>.
0062   //! An exception is raised if <index> is out of range.
0063   Standard_EXPORT virtual occ::handle<Expr_GeneralRelation> SubRelation(const int index) const = 0;
0064
0065   //! Tests if <exp> contains <var>.
0066   Standard_EXPORT virtual bool Contains(const occ::handle<Expr_GeneralExpression>& exp) const = 0;
0067
0068   //! Replaces all occurrences of <var> with <with> in <me>.
0069   Standard_EXPORT virtual void Replace(const occ::handle<Expr_NamedUnknown>&      var,
0070                                        const occ::handle<Expr_GeneralExpression>& with) = 0;
0071
0072   //! returns a string representing <me> in a readable way.
0073   Standard_EXPORT virtual TCollection_AsciiString String() const = 0;
0074
0075   DEFINE_STANDARD_RTTIEXT(Expr_GeneralRelation, Standard_Transient)
0076 };
0077
0078 #endif // _Expr_GeneralRelation_HeaderFile