Poco::DirectoryIterator Class Reference

#include <DirectoryIterator.h>

List of all members.

Public Member Functions

 DirectoryIterator (const Path &path)
 Creates a directory iterator for the given file.
 DirectoryIterator (const File &file)
 Creates a directory iterator for the given path.
 DirectoryIterator (const DirectoryIterator &iterator)
 Creates a directory iterator for the given path.
 DirectoryIterator (const std::string &path)
 Creates the end iterator.
 DirectoryIterator ()
const std::string & name () const
 Destroys the DirectoryIterator.
bool operator!= (const DirectoryIterator &iterator) const
Fileoperator* ()
const Fileoperator* () const
 Please use the prefix increment operator instead.
DirectoryIterator operator++ (int)
DirectoryIteratoroperator++ ()
Fileoperator-> ()
const Fileoperator-> () const
DirectoryIteratoroperator= (const std::string &path)
DirectoryIteratoroperator= (const Path &path)
DirectoryIteratoroperator= (const File &file)
DirectoryIteratoroperator= (const DirectoryIterator &it)
 Returns the current 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 52 of file DirectoryIterator.h.


Constructor & Destructor Documentation

Poco::DirectoryIterator::DirectoryIterator (  ) 

Definition at line 51 of file DirectoryIterator.cpp.

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

Creates the end iterator.

Definition at line 56 of file DirectoryIterator.cpp.

Poco::DirectoryIterator::DirectoryIterator ( const DirectoryIterator iterator  ) 

Creates a directory iterator for the given path.

Definition at line 64 of file DirectoryIterator.cpp.

Poco::DirectoryIterator::DirectoryIterator ( const File file  ) 

Creates a directory iterator for the given path.

Definition at line 76 of file DirectoryIterator.cpp.

Poco::DirectoryIterator::DirectoryIterator ( const Path path  ) 

Creates a directory iterator for the given file.

Definition at line 84 of file DirectoryIterator.cpp.

Poco::DirectoryIterator::~DirectoryIterator (  ) 

Creates a directory iterator for the given path.

Definition at line 92 of file DirectoryIterator.cpp.


Member Function Documentation

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

Destroys the DirectoryIterator.

Definition at line 120 of file DirectoryIterator.h.

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

Definition at line 162 of file DirectoryIterator.h.

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

Definition at line 138 of file DirectoryIterator.h.

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

Please use the prefix increment operator instead.

Definition at line 132 of file DirectoryIterator.h.

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

Definition at line 157 of file DirectoryIterator.cpp.

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

Definition at line 146 of file DirectoryIterator.cpp.

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

Definition at line 150 of file DirectoryIterator.h.

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

Definition at line 144 of file DirectoryIterator.h.

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

Definition at line 135 of file DirectoryIterator.cpp.

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

Definition at line 123 of file DirectoryIterator.cpp.

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

Definition at line 112 of file DirectoryIterator.cpp.

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

Returns the current path.

Definition at line 98 of file DirectoryIterator.cpp.

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

Definition at line 156 of file DirectoryIterator.h.

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

Returns the current filename.

Definition at line 126 of file DirectoryIterator.h.


Member Data Documentation

Definition at line 112 of file DirectoryIterator.h.

Definition at line 111 of file DirectoryIterator.h.

Definition at line 113 of file DirectoryIterator.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


pluginlib
Author(s): Tully Foote and Eitan Marder-Eppstein
autogenerated on Fri Jan 11 11:39:01 2013