indri::file::FileTreeIterator Class Reference

#include <FileTreeIterator.hpp>

List of all members.

Public Member Functions
	FileTreeIterator ()
	FileTreeIterator (const std::string &path)
	~FileTreeIterator ()
void	operator++ (int)
	Moves to the next file within the directory tree.
void	operator++ ()
	Moves to the next file within the directory tree.
bool	operator== (const FileTreeIterator &other) const
bool	operator!= (const FileTreeIterator &other) const
const std::string &	operator * ()
	Returns the full path to a file within the directory tree.
Static Public Member Functions
const FileTreeIterator &	end ()
Private Member Functions
void	_nextCandidate ()
void	_next ()
Private Attributes
std::stack< DirectoryIterator * >	_stack
std::string	_current
Static Private Attributes
FileTreeIterator	_end

---

Detailed Description

Provides iteration over the files in a directory tree.

---

Constructor & Destructor Documentation

indri::file::FileTreeIterator::FileTreeIterator (   )

indri::file::FileTreeIterator::FileTreeIterator (  const std::string &  path  )

indri::file::FileTreeIterator::~FileTreeIterator (   )

---

Member Function Documentation

void indri::file::FileTreeIterator::_next (   )  [private]

void indri::file::FileTreeIterator::_nextCandidate (   )  [private]

const indri::file::FileTreeIterator & indri::file::FileTreeIterator::end (   )  [static]

Placeholder object that indicates a finished iteration. Use this with operator != to tell when iteration is finished.

const std::string & indri::file::FileTreeIterator::operator * (   )

Returns the full path to a file within the directory tree.

bool indri::file::FileTreeIterator::operator!= (  const FileTreeIterator &  other  )  const

Used only for comparison with FileTreeIterator::end. If true, the iteration is complete.

void indri::file::FileTreeIterator::operator++ (   )

Moves to the next file within the directory tree.

void indri::file::FileTreeIterator::operator++ (  int   )

Moves to the next file within the directory tree.

bool indri::file::FileTreeIterator::operator== (  const FileTreeIterator &  other  )  const

Used only for comparison with FileTreeIterator::end. If false, the iteration is complete.

---

Member Data Documentation

std::string indri::file::FileTreeIterator::_current [private]

indri::file::FileTreeIterator indri::file::FileTreeIterator::_end [static, private]

std::stack<DirectoryIterator*> indri::file::FileTreeIterator::_stack [private]

---

The documentation for this class was generated from the following files:

• FileTreeIterator.hpp
• FileTreeIterator.cpp

---