[occt.git] / src / CDF / CDF_DirectoryIterator.hxx

// Created on: 1997-08-13
// Created by: Jean-Louis Frenkel
// Copyright (c) 1997-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _CDF_DirectoryIterator_HeaderFile
#define _CDF_DirectoryIterator_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>

#include <CDM_ListIteratorOfListOfDocument.hxx>
#include <Standard_Boolean.hxx>
class Standard_NoSuchObject;
class CDF_Directory;
class CDM_Document;


class CDF_DirectoryIterator 
{
public:

  DEFINE_STANDARD_ALLOC

  
  //! creates an Iterator with the directory
  //! of the current CDF.
  Standard_EXPORT CDF_DirectoryIterator();
  
  Standard_EXPORT CDF_DirectoryIterator(const Handle(CDF_Directory)& aDirectory);
  
  //! Returns True if there are more entries to return
  Standard_EXPORT Standard_Boolean MoreDocument();
  
  //! Go to the next entry
  //! (if there is not, Value will raise an exception)
  Standard_EXPORT void NextDocument();
  
  //! Returns item value of current entry
  Standard_EXPORT Handle(CDM_Document) Document();


protected:


private:


  CDM_ListIteratorOfListOfDocument myIterator;


};


#endif // _CDF_DirectoryIterator_HeaderFile
Commit	Line	Data
42cf5bc1	1	// Created on: 1997-08-13
	2	// Created by: Jean-Louis Frenkel
	3	// Copyright (c) 1997-1999 Matra Datavision
	4	// Copyright (c) 1999-2014 OPEN CASCADE SAS
	5	//
	6	// This file is part of Open CASCADE Technology software library.
	7	//
	8	// This library is free software; you can redistribute it and/or modify it under
	9	// the terms of the GNU Lesser General Public License version 2.1 as published
	10	// by the Free Software Foundation, with special exception defined in the file
	11	// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	12	// distribution for complete text of the license and disclaimer of any warranty.
	13	//
	14	// Alternatively, this file may be used under the terms of Open CASCADE
	15	// commercial license or contractual agreement.
	16
	17	#ifndef _CDF_DirectoryIterator_HeaderFile
	18	#define _CDF_DirectoryIterator_HeaderFile
	19
	20	#include <Standard.hxx>
	21	#include <Standard_DefineAlloc.hxx>
	22	#include <Standard_Handle.hxx>
	23
	24	#include <CDM_ListIteratorOfListOfDocument.hxx>
	25	#include <Standard_Boolean.hxx>
	26	class Standard_NoSuchObject;
	27	class CDF_Directory;
	28	class CDM_Document;
	29
	30
	31
	32	class CDF_DirectoryIterator
	33	{
	34	public:
	35
	36	DEFINE_STANDARD_ALLOC
	37
	38
	39	//! creates an Iterator with the directory
	40	//! of the current CDF.
	41	Standard_EXPORT CDF_DirectoryIterator();
	42
	43	Standard_EXPORT CDF_DirectoryIterator(const Handle(CDF_Directory)& aDirectory);
	44
	45	//! Returns True if there are more entries to return
	46	Standard_EXPORT Standard_Boolean MoreDocument();
	47
	48	//! Go to the next entry
	49	//! (if there is not, Value will raise an exception)
	50	Standard_EXPORT void NextDocument();
	51
	52	//! Returns item value of current entry
	53	Standard_EXPORT Handle(CDM_Document) Document();
	54
	55
	56
	57
	58	protected:
	59
	60
	61
	62
	63
	64	private:
65
66
67
68	CDM_ListIteratorOfListOfDocument myIterator;
69
70
71	};
72
73
74
75
76
77
78
79	#endif // _CDF_DirectoryIterator_HeaderFile