src/TObj/TObj_ObjectIterator.hxx

   1 // Created on: 2004-11-23
   2 // Created by: Pavel TELKOV
   3 // Copyright (c) 2004-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 // The original implementation Copyright: (C) RINA S.p.A
  17
  18 #ifndef TObj_ObjectIterator_HeaderFile
  19 #define TObj_ObjectIterator_HeaderFile
  20
  21 #include <TObj_Common.hxx>
  22
  23 class TObj_Object;
  24
  25 /**
  26 * This class provides an iterator by objects in a partition.
  27 * (implements TObj_ObjectIterator interface)
  28 */
  29
  30 class TObj_ObjectIterator : public Standard_Transient
  31 {
  32  public:
  33   /*
  34   * Methods to iterate on a objects
  35   */
  36
  37   //! Returns True if iteration is not finished and method Current()
  38   //! will give the object.
  39   //! Default implementation returns False
  40   virtual Standard_EXPORT Standard_Boolean More () const;
  41
  42   //! Iterates to the next object
  43   //! Default implementation does nothing
  44   virtual Standard_EXPORT void Next ();
  45
  46   //! Returns current object (or null if iteration has finished)
  47   //! Default implementation returns null handle
  48   virtual Standard_EXPORT Handle(TObj_Object) Value () const;
  49
  50  public:
  51    //! CASCADE RTTI
  52   DEFINE_STANDARD_RTTIEXT(TObj_ObjectIterator,Standard_Transient)
  53 };
  54
  55 //! Define handle class for TObj_ObjectIterator
  56 DEFINE_STANDARD_HANDLE(TObj_ObjectIterator,Standard_Transient)
  57
  58 #endif
  59
  60 #ifdef _MSC_VER
  61 #pragma once
  62 #endif