include/opencascade/TObj_ObjectIterator.hxx

0001 // Created on: 2004-11-23
0002 // Created by: Pavel TELKOV
0003 // Copyright (c) 2004-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 // The original implementation Copyright: (C) RINA S.p.A
0017
0018 #ifndef TObj_ObjectIterator_HeaderFile
0019 #define TObj_ObjectIterator_HeaderFile
0020
0021 #include <Standard_Handle.hxx>
0022 #include <Standard_DefineHandle.hxx>
0023
0024 class TObj_Object;
0025
0026 /**
0027 * This class provides an iterator by objects in a partition.
0028 * (implements TObj_ObjectIterator interface)
0029 */
0030
0031 class TObj_ObjectIterator : public Standard_Transient
0032 {
0033  public:
0034   /*
0035   * Methods to iterate on a objects
0036   */
0037
0038   //! Returns True if iteration is not finished and method Current()
0039   //! will give the object.
0040   //! Default implementation returns False
0041   virtual Standard_EXPORT Standard_Boolean More () const;
0042
0043   //! Iterates to the next object
0044   //! Default implementation does nothing
0045   virtual Standard_EXPORT void Next ();
0046
0047   //! Returns current object (or null if iteration has finished)
0048   //! Default implementation returns null handle
0049   virtual Standard_EXPORT Handle(TObj_Object) Value () const;
0050
0051  public:
0052    //! CASCADE RTTI
0053   DEFINE_STANDARD_RTTIEXT(TObj_ObjectIterator,Standard_Transient)
0054 };
0055
0056 //! Define handle class for TObj_ObjectIterator
0057 DEFINE_STANDARD_HANDLE(TObj_ObjectIterator,Standard_Transient)
0058
0059 #endif
0060
0061 #ifdef _MSC_VER
0062 #pragma once
0063 #endif