Public Member Functions | Private Attributes
Poco::DirectoryIterator Class Reference

#include <DirectoryIterator.h>

List of all members.

Public Member Functions

 DirectoryIterator ()
 DirectoryIterator (const std::string &path)
 Creates the end iterator.
 DirectoryIterator (const DirectoryIterator &iterator)
 Creates a directory iterator for the given path.
 DirectoryIterator (const File &file)
 Creates a directory iterator for the given path.
 DirectoryIterator (const Path &path)
 Creates a directory iterator for the given file.
const std::string & name () const
 Destroys the DirectoryIterator.
bool operator!= (const DirectoryIterator &iterator) const
const Fileoperator* () const
 Please use the prefix increment operator instead.
Fileoperator* ()
DirectoryIteratoroperator++ ()
DirectoryIterator operator++ (int)
const Fileoperator-> () const
Fileoperator-> ()
DirectoryIteratoroperator= (const DirectoryIterator &it)
 Returns the current path.
DirectoryIteratoroperator= (const File &file)
DirectoryIteratoroperator= (const Path &path)
DirectoryIteratoroperator= (const std::string &path)
bool operator== (const DirectoryIterator &iterator) const
const Pathpath () const
 Returns the current filename.
 ~DirectoryIterator ()
 Creates a directory iterator for the given path.

Private Attributes

File _file
Path _path
DirectoryIteratorImpl_pImpl

Detailed Description

The DirectoryIterator class is used to enumerate all files in a directory.

DirectoryIterator has some limitations: only forward iteration (++) is supported an iterator copied from another one will always point to the same file as the original iterator, even is the original iterator has been advanced (all copies of an iterator share their state with the original iterator) because of this you should only use the prefix increment operator

Definition at line 54 of file DirectoryIterator.h.


Constructor & Destructor Documentation

Definition at line 54 of file DirectoryIterator.cpp.

Poco::DirectoryIterator::DirectoryIterator ( const std::string &  path)

Creates the end iterator.

Definition at line 59 of file DirectoryIterator.cpp.

Creates a directory iterator for the given path.

Definition at line 67 of file DirectoryIterator.cpp.

Creates a directory iterator for the given path.

Definition at line 79 of file DirectoryIterator.cpp.

Creates a directory iterator for the given file.

Definition at line 87 of file DirectoryIterator.cpp.

Creates a directory iterator for the given path.

Definition at line 95 of file DirectoryIterator.cpp.


Member Function Documentation

const std::string & Poco::DirectoryIterator::name ( ) const [inline]

Destroys the DirectoryIterator.

Definition at line 122 of file DirectoryIterator.h.

bool Poco::DirectoryIterator::operator!= ( const DirectoryIterator iterator) const [inline]

Definition at line 164 of file DirectoryIterator.h.

const File & Poco::DirectoryIterator::operator* ( ) const [inline]

Please use the prefix increment operator instead.

Definition at line 134 of file DirectoryIterator.h.

File & Poco::DirectoryIterator::operator* ( ) [inline]

Definition at line 140 of file DirectoryIterator.h.

DirectoryIterator & Poco::DirectoryIterator::operator++ ( )

Definition at line 149 of file DirectoryIterator.cpp.

DirectoryIterator Poco::DirectoryIterator::operator++ ( int  dummy)

Definition at line 160 of file DirectoryIterator.cpp.

const File * Poco::DirectoryIterator::operator-> ( ) const [inline]

Definition at line 146 of file DirectoryIterator.h.

File * Poco::DirectoryIterator::operator-> ( ) [inline]

Definition at line 152 of file DirectoryIterator.h.

DirectoryIterator & Poco::DirectoryIterator::operator= ( const DirectoryIterator it)

Returns the current path.

Definition at line 101 of file DirectoryIterator.cpp.

DirectoryIterator & Poco::DirectoryIterator::operator= ( const File file)

Definition at line 115 of file DirectoryIterator.cpp.

DirectoryIterator & Poco::DirectoryIterator::operator= ( const Path path)

Definition at line 126 of file DirectoryIterator.cpp.

DirectoryIterator & Poco::DirectoryIterator::operator= ( const std::string &  path)

Definition at line 138 of file DirectoryIterator.cpp.

bool Poco::DirectoryIterator::operator== ( const DirectoryIterator iterator) const [inline]

Definition at line 158 of file DirectoryIterator.h.

const Path & Poco::DirectoryIterator::path ( ) const [inline]

Returns the current filename.

Definition at line 128 of file DirectoryIterator.h.


Member Data Documentation

Definition at line 114 of file DirectoryIterator.h.

Definition at line 113 of file DirectoryIterator.h.

Definition at line 115 of file DirectoryIterator.h.


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


pluginlib
Author(s): Tully Foote and Eitan Marder-Eppstein
autogenerated on Sat Dec 28 2013 17:20:20