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_ListIteratorOfListOfDocument.hxx>
0025 class CDF_Directory;
0026 class CDM_Document;
0027
0028
0029
0030 class CDF_DirectoryIterator
0031 {
0032 public:
0033
0034   DEFINE_STANDARD_ALLOC
0035
0036
0037   //! creates an Iterator with the directory
0038   //! of the current CDF.
0039   Standard_EXPORT CDF_DirectoryIterator();
0040
0041   Standard_EXPORT CDF_DirectoryIterator(const Handle(CDF_Directory)& aDirectory);
0042
0043   //! Returns True if there are more entries to return
0044   Standard_EXPORT Standard_Boolean MoreDocument();
0045
0046   //! Go to the next entry
0047   //! (if there is not, Value will raise an exception)
0048   Standard_EXPORT void NextDocument();
0049
0050   //! Returns item value of current entry
0051   Standard_EXPORT Handle(CDM_Document) Document();
0052
0053
0054
0055
0056 protected:
0057
0058
0059
0060
0061
0062 private:
0063
0064
0065
0066   CDM_ListIteratorOfListOfDocument myIterator;
0067
0068
0069 };
0070
0071
0072
0073
0074
0075
0076
0077 #endif // _CDF_DirectoryIterator_HeaderFile