CeresEngine::IFileIterator Class Reference

Interface for iterating on directories. More...

#include <CeresEngine/Foundation/IO/FileHandle.hpp>

Inheritance diagram for CeresEngine::IFileIterator:

Public Member Functions
	IFileIterator ()=default
virtual	~IFileIterator ()=default
virtual IFileSystem *	getFileSystem () const =0
virtual bool	isValid () const =0
	Checks if iterator points to a valid item.
virtual const FileHandle &	getParent () const =0
	Gets the parent FileHandle this iterator iterates over.
virtual Int32	getIndex () const =0
	Gets the current index of iterator in the directory.
virtual FileHandle	getFileHandle () const =0
	Gets the current entry file handle.
virtual void	next ()=0
	Advances to the next item.

Detailed Description

Interface for iterating on directories.

Constructor & Destructor Documentation

IFileIterator()

CeresEngine::IFileIterator::IFileIterator ( )

default

~IFileIterator()

virtual CeresEngine::IFileIterator::~IFileIterator ( )

virtualdefault

Member Function Documentation

getFileHandle()

virtual FileHandle CeresEngine::IFileIterator::getFileHandle ( ) const

pure virtual

Gets the current entry file handle.

Implemented in CeresEngine::LocalFileIterator.

getFileSystem()

virtual IFileSystem * CeresEngine::IFileIterator::getFileSystem ( ) const

pure virtual

Implemented in CeresEngine::LocalFileIterator.

getIndex()

virtual Int32 CeresEngine::IFileIterator::getIndex ( ) const

pure virtual

Gets the current index of iterator in the directory.

Returns

The Index, -1 if invalid.

Implemented in CeresEngine::LocalFileIterator.

getParent()

virtual const FileHandle & CeresEngine::IFileIterator::getParent ( ) const

pure virtual

Gets the parent FileHandle this iterator iterates over.

Implemented in CeresEngine::LocalFileIterator.

isValid()

virtual bool CeresEngine::IFileIterator::isValid ( ) const

pure virtual

Checks if iterator points to a valid item.

Returns

true if valid, else false.

Implemented in CeresEngine::LocalFileIterator.

next()

virtual void CeresEngine::IFileIterator::next ( )

pure virtual

Advances to the next item.

Implemented in CeresEngine::LocalFileIterator.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Foundation/IO/FileHandle.hpp