include/opencascade/CDF_DirectoryIterator.hxx

0001 // Created on: 1997-08-13
0002 // Created by: Jean-Louis Frenkel
0003 // Copyright (c) 1997-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 _CDF_DirectoryIterator_HeaderFile
0018 #define _CDF_DirectoryIterator_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <CDM_Document.hxx>
0025
0026 #include <NCollection_List.hxx>
0027 class CDF_Directory;
0028 class CDM_Document;
0029
0030 class CDF_DirectoryIterator
0031 {
0032 public:
0033   DEFINE_STANDARD_ALLOC
0034
0035   //! creates an Iterator with the directory
0036   //! of the current CDF.
0037   Standard_EXPORT CDF_DirectoryIterator();
0038
0039   Standard_EXPORT CDF_DirectoryIterator(const occ::handle<CDF_Directory>& aDirectory);
0040
0041   //! Returns True if there are more entries to return
0042   Standard_EXPORT bool MoreDocument();
0043
0044   //! Go to the next entry
0045   //! (if there is not, Value will raise an exception)
0046   Standard_EXPORT void NextDocument();
0047
0048   //! Returns item value of current entry
0049   Standard_EXPORT occ::handle<CDM_Document> Document();
0050
0051 private:
0052   NCollection_List<occ::handle<CDM_Document>>::Iterator myIterator;
0053 };
0054
0055 #endif // _CDF_DirectoryIterator_HeaderFile