include/opencascade/Expr_RUIterator.hxx

0001 // Created on: 1991-02-06
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_RUIterator_HeaderFile
0018 #define _Expr_RUIterator_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Expr_MapOfNamedUnknown.hxx>
0025 #include <Standard_Integer.hxx>
0026 class Expr_GeneralRelation;
0027 class Expr_NamedUnknown;
0028
0029 //! Iterates on NamedUnknowns in a GeneralRelation.
0030 class Expr_RUIterator
0031 {
0032 public:
0033   DEFINE_STANDARD_ALLOC
0034
0035   //! Creates an iterator on every NamedUnknown contained in
0036   //! <rel>.
0037   Standard_EXPORT Expr_RUIterator(const Handle(Expr_GeneralRelation)& rel);
0038
0039   //! Returns False if on other unknown remains.
0040   Standard_EXPORT Standard_Boolean More() const;
0041
0042   Standard_EXPORT void Next();
0043
0044   //! Returns current NamedUnknown.
0045   //! Raises exception if no more unknowns remain.
0046   Standard_EXPORT Handle(Expr_NamedUnknown) Value() const;
0047
0048 protected:
0049 private:
0050   Expr_MapOfNamedUnknown myMap;
0051   Standard_Integer       myCurrent;
0052 };
0053
0054 #endif // _Expr_RUIterator_HeaderFile