OKlibrary  0.2.1.6
OKlib::GeneralInputOutput::DirectoryIterator Class Reference

Class which provides recursive input iterators over the non-directory files within a directory. More...

#include <RecursiveDirectoryIteration.hpp>

List of all members.

Classes

class  post_increment_proxy

Public Types

typedef std::input_iterator_tag iterator_category
typedef
directory_iterator::value_type 
value_type
typedef
directory_iterator::difference_type 
difference_type
typedef directory_iterator::pointer pointer
typedef
directory_iterator::reference 
reference

Public Member Functions

 DirectoryIterator ()
 DirectoryIterator (const boost::filesystem::path &directory_ph)
value_type operator* () const
DirectoryIteratoroperator++ ()
post_increment_proxy operator++ (int)

Friends

bool operator== (const DirectoryIterator &lhs, const DirectoryIterator &rhs)

Detailed Description

Class which provides recursive input iterators over the non-directory files within a directory.

Todo:

A more complete explanation is needed.

A strategy object should filter the paths (excluding some).

Handling of links needs to be customised (and documented).

Designing a concept; the domain of == allows comparison with the unique past-the-end iterator. The concept InputIterator should refine InputIteratorDefault and MultiPassInputIterator (???).

Definition at line 39 of file RecursiveDirectoryIteration.hpp.


Member Typedef Documentation

typedef directory_iterator::difference_type OKlib::GeneralInputOutput::DirectoryIterator::difference_type

Definition at line 48 of file RecursiveDirectoryIteration.hpp.

Definition at line 46 of file RecursiveDirectoryIteration.hpp.

typedef directory_iterator::pointer OKlib::GeneralInputOutput::DirectoryIterator::pointer

Definition at line 49 of file RecursiveDirectoryIteration.hpp.

typedef directory_iterator::reference OKlib::GeneralInputOutput::DirectoryIterator::reference

Definition at line 50 of file RecursiveDirectoryIteration.hpp.

typedef directory_iterator::value_type OKlib::GeneralInputOutput::DirectoryIterator::value_type

Definition at line 47 of file RecursiveDirectoryIteration.hpp.


Constructor & Destructor Documentation

OKlib::GeneralInputOutput::DirectoryIterator::DirectoryIterator ( const boost::filesystem::path &  directory_ph) [inline]

Definition at line 54 of file RecursiveDirectoryIteration.hpp.


Member Function Documentation

value_type OKlib::GeneralInputOutput::DirectoryIterator::operator* ( ) const [inline]

Definition at line 61 of file RecursiveDirectoryIteration.hpp.

DirectoryIterator& OKlib::GeneralInputOutput::DirectoryIterator::operator++ ( ) [inline]

Definition at line 65 of file RecursiveDirectoryIteration.hpp.

Referenced by operator++().

post_increment_proxy OKlib::GeneralInputOutput::DirectoryIterator::operator++ ( int  ) [inline]

Definition at line 90 of file RecursiveDirectoryIteration.hpp.

References operator++().


Friends And Related Function Documentation

bool operator== ( const DirectoryIterator lhs,
const DirectoryIterator rhs 
) [friend]

Definition at line 96 of file RecursiveDirectoryIteration.hpp.


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