Main Page   Alphabetical List   Compound List   File List   Compound Members  

sord::directory Class Reference

#include <directory.h>

List of all members.

Public Methods

 directory (const char *path)
 directory (const entry &e)
 ~directory (void)
const_iteratorbegin (void) const
const_iteratorend (void) const
const char * get_name (void) const
bool operator! (void) const


Detailed Description

The sord::directory class is used to iterate over the entires in a directory.


Constructor & Destructor Documentation

sord::directory::directory const char *    path [explicit]
 

sord::directory constructor

Parameters:
path  The path to the directory to open
Author:
Peter Jones

sord::directory::directory const entry   e [explicit]
 

sord::directory constructor

Parameters:
e  A sord::entry that refers to a directory to open
Author:
Peter Jones

sord::directory::~directory void   
 

sord::directory destructor

Author:
Peter Jones


Member Function Documentation

const_iterator& sord::directory::begin void    const
 

Get an iterator to the begining of the directory listing.

Returns:
A const_iterator that points to the start of the directory
Author:
Peter Jones

const_iterator& sord::directory::end void    const
 

Get an end iterator for the directory listing.

Returns:
A const_iterator that points one element past the end.
Author:
Peter Jones

const char* sord::directory::get_name void    const
 

Get the name of this directory. This may or may not be the same as the name you gave in the constructor.

Returns:
The name of this directory.
Author:
Peter Jones

bool sord::directory::operator! void    const
 

Find out if the directory opened was vaild.

Returns:
True if the directory was NOT VAILD; false if it was vaild.
Author:
Peter Jones


The documentation for this class was generated from the following file:
Generated on Thu Jun 20 14:56:30 2002 for sord by doxygen1.2.16