include/opencascade/TObj_OcafObjectIterator.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_OcafObjectIterator_HeaderFile
0019 #define TObj_OcafObjectIterator_HeaderFile
0020
0021 #include <TObj_LabelIterator.hxx>
0022
0023 /**
0024 * This class provides an iterator by objects in a partition.
0025 * (implements TObj_ObjectIterator interface)
0026 */
0027
0028 class TObj_OcafObjectIterator : public TObj_LabelIterator
0029 {
0030 public:
0031   //! Creates the iterator on TObj objects on the sub-labels of theLabel.
0032   //! @param theLabel start label for searching
0033   //! @param theType type of the found objects, or all types if Null
0034   //! @param theRecursive search children recursively, not only on sub-labels of theLabel
0035   //! @param theAllSubChildren do not stop at the first level of children, but search for sub-children too
0036   Standard_EXPORT TObj_OcafObjectIterator
0037                          (const TDF_Label&             theLabel,
0038                           const Handle(Standard_Type)& theType = NULL,
0039                           const Standard_Boolean       theRecursive = Standard_False,
0040                           const Standard_Boolean       theAllSubChildren = Standard_False);
0041
0042 protected:
0043   //! Shift iterator to the next object
0044   virtual Standard_EXPORT void MakeStep() Standard_OVERRIDE;
0045
0046 protected:
0047   Handle(Standard_Type) myType; //!< type of objects to iterate on
0048   Standard_Boolean myAllSubChildren; //!< to iterate all sub-children, do not stop on the first level
0049
0050 public:
0051   //! CASCADE RTTI
0052   DEFINE_STANDARD_RTTIEXT(TObj_OcafObjectIterator,TObj_LabelIterator)
0053 };
0054
0055 //! Define handle class for TObj_OcafObjectIterator
0056 DEFINE_STANDARD_HANDLE(TObj_OcafObjectIterator,TObj_LabelIterator)
0057
0058 #endif
0059
0060 #ifdef _MSC_VER
0061 #pragma once
0062 #endif