Public Member Functions | Private Attributes | List of all members
alvar::DirectoryIterator Class Reference

DirectoryIterator for iterating over files and directories. More...

#include <DirectoryIterator.h>

Public Member Functions

std::string currentEntry ()
 Returns the name of the current entry. More...
 
std::string currentPath ()
 Returns the path of the current entry. More...
 
 DirectoryIterator (const std::string &path)
 Constructor. More...
 
bool hasNext ()
 Verifies if another entry exist in the directory. More...
 
std::string next ()
 Advances the iterator and returns the name of the next entry. More...
 
 ~DirectoryIterator ()
 Destructor. More...
 

Private Attributes

DirectoryIteratorPrivated
 

Detailed Description

DirectoryIterator for iterating over files and directories.

DirectoryIterator class for iterating over files and directories on the filesystem.

Definition at line 46 of file DirectoryIterator.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters
pathThe path on the filesystem to iterate.

Definition at line 30 of file DirectoryIterator.cpp.

alvar::DirectoryIterator::~DirectoryIterator ( )

Destructor.

Definition at line 35 of file DirectoryIterator.cpp.

Member Function Documentation

std::string alvar::DirectoryIterator::currentEntry ( )

Returns the name of the current entry.

Definition at line 50 of file DirectoryIterator.cpp.

std::string alvar::DirectoryIterator::currentPath ( )

Returns the path of the current entry.

This appends the name of the current entry to the path of the directory that is being iterated.

Definition at line 55 of file DirectoryIterator.cpp.

bool alvar::DirectoryIterator::hasNext ( )

Verifies if another entry exist in the directory.

Definition at line 40 of file DirectoryIterator.cpp.

std::string alvar::DirectoryIterator::next ( )

Advances the iterator and returns the name of the next entry.

Definition at line 45 of file DirectoryIterator.cpp.

Member Data Documentation

DirectoryIteratorPrivate* alvar::DirectoryIterator::d
private

Definition at line 85 of file DirectoryIterator.h.


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


ar_track_alvar
Author(s): Scott Niekum
autogenerated on Thu Jun 6 2019 19:27:24