include/opencascade/Expr_SingleRelation.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_SingleRelation_HeaderFile
0018 #define _Expr_SingleRelation_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Expr_GeneralRelation.hxx>
0024 #include <Standard_Integer.hxx>
0025 class Expr_GeneralExpression;
0026 class Expr_NamedUnknown;
0027
0028 class Expr_SingleRelation;
0029 DEFINE_STANDARD_HANDLE(Expr_SingleRelation, Expr_GeneralRelation)
0030
0031 class Expr_SingleRelation : public Expr_GeneralRelation
0032 {
0033
0034 public:
0035   //! Defines the first member of the relation
0036   Standard_EXPORT void SetFirstMember(const Handle(Expr_GeneralExpression)& exp);
0037
0038   //! Defines the second member of the relation
0039   Standard_EXPORT void SetSecondMember(const Handle(Expr_GeneralExpression)& exp);
0040
0041   //! Returns the first member of the relation
0042   Standard_EXPORT Handle(Expr_GeneralExpression) FirstMember() const;
0043
0044   //! Returns the second member of the relation
0045   Standard_EXPORT Handle(Expr_GeneralExpression) SecondMember() const;
0046
0047   //! Tests if <me> is linear between its NamedUnknowns.
0048   Standard_EXPORT Standard_Boolean IsLinear() const Standard_OVERRIDE;
0049
0050   //! Returns the number of relations contained in <me>.
0051   Standard_EXPORT Standard_Integer NbOfSubRelations() const Standard_OVERRIDE;
0052
0053   //! Returns the number of SingleRelations contained in
0054   //! <me> (Always 1).
0055   Standard_EXPORT Standard_Integer NbOfSingleRelations() const Standard_OVERRIDE;
0056
0057   //! Returns the relation denoted by <index> in <me>.
0058   //! An exception is raised if index is out of range.
0059   Standard_EXPORT Handle(Expr_GeneralRelation) SubRelation(const Standard_Integer index) const
0060     Standard_OVERRIDE;
0061
0062   //! Tests if <me> contains <exp>.
0063   Standard_EXPORT Standard_Boolean
0064     Contains(const Handle(Expr_GeneralExpression)& exp) const Standard_OVERRIDE;
0065
0066   //! Replaces all occurrences of <var> with <with> in <me>.
0067   Standard_EXPORT void Replace(const Handle(Expr_NamedUnknown)&      var,
0068                                const Handle(Expr_GeneralExpression)& with) Standard_OVERRIDE;
0069
0070   DEFINE_STANDARD_RTTIEXT(Expr_SingleRelation, Expr_GeneralRelation)
0071
0072 protected:
0073 private:
0074   Handle(Expr_GeneralExpression) myFirstMember;
0075   Handle(Expr_GeneralExpression) mySecondMember;
0076 };
0077
0078 #endif // _Expr_SingleRelation_HeaderFile