[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>
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>
42cf5bc1	25	class CDF_Directory;
	26	class CDM_Document;
	27
	28
	29
	30	class CDF_DirectoryIterator
	31	{
	32	public:
	33
	34	DEFINE_STANDARD_ALLOC
	35
	36
	37	//! creates an Iterator with the directory
	38	//! of the current CDF.
	39	Standard_EXPORT CDF_DirectoryIterator();
	40
	41	Standard_EXPORT CDF_DirectoryIterator(const Handle(CDF_Directory)& aDirectory);
	42
	43	//! Returns True if there are more entries to return
	44	Standard_EXPORT Standard_Boolean MoreDocument();
	45
	46	//! Go to the next entry
	47	//! (if there is not, Value will raise an exception)
	48	Standard_EXPORT void NextDocument();
	49
	50	//! Returns item value of current entry
	51	Standard_EXPORT Handle(CDM_Document) Document();
	52
	53
	54
	55
	56	protected:
	57
	58
	59
	60
	61
	62	private:
	63
	64
	65
	66	CDM_ListIteratorOfListOfDocument myIterator;
	67
	68
	69	};
	70
	71
	72
	73
	74
	75
	76
	77	#endif // _CDF_DirectoryIterator_HeaderFile