src/TObj/TObj_OcafObjectIterator.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_OcafObjectIterator_HeaderFile
  19 #define TObj_OcafObjectIterator_HeaderFile
  20
  21 #include <TObj_LabelIterator.hxx>
  22
  23 /**
  24 * This class provides an iterator by objects in a partition.
  25 * (implements TObj_ObjectIterator interface)
  26 */
  27
  28 class TObj_OcafObjectIterator : public TObj_LabelIterator
  29 {
  30  public:
  31   /**
  32   * Constructor
  33   */
  34
  35   //! Creates the iterator on objects in the sub labels of theLabel
  36   //! theType narrows a variety of iterated objects
  37   Standard_EXPORT TObj_OcafObjectIterator
  38                          (const TDF_Label&             theLabel,
  39                           const Handle(Standard_Type)& theType = NULL,
  40                           const Standard_Boolean       theRecursive = Standard_False);
  41
  42  protected:
  43   /*
  44   * Internal methods
  45   */
  46
  47   //! Shift iterator to the next object
  48   virtual Standard_EXPORT void MakeStep() Standard_OVERRIDE;
  49
  50  protected:
  51   /**
  52   * fields
  53   */
  54
  55   Handle(Standard_Type) myType; //!< type of objects to iterate on
  56
  57  public:
  58    //! CASCADE RTTI
  59   DEFINE_STANDARD_RTTIEXT(TObj_OcafObjectIterator,TObj_LabelIterator)
  60 };
  61
  62 //! Define handle class for TObj_OcafObjectIterator
  63 DEFINE_STANDARD_HANDLE(TObj_OcafObjectIterator,TObj_LabelIterator)
  64
  65 #endif
  66
  67 #ifdef _MSC_VER
  68 #pragma once
  69 #endif