Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Directory Class Reference

class containing all or some files of a directory. More...

#include <Directory.h>

Inheritance diagram for rs::file::Directory:

Inheritance graph
[legend]
Collaboration diagram for Directory:

Collaboration graph
[legend]
List of all members.

Public Methods

 Directory ()
 Create a Directory. More...

virtual ~Directory ()
void addFile (const std::string &filename, time_t t)
 adds a filename to Directory. More...

void setName (const std::string &dirname)
 change directory name. More...

const std::string & name () const
 get name of directory. More...

size_t size () const
 get number of files in directory. More...

std::set< std::string >::const_iterator begin () const
 iterator for files in directory. More...

std::set< std::string >::const_iterator end () const
 iterator for files in directory. More...

std::string fullPath (const std::string &filename) const
 return full path name of a file. More...

time_t oldest () const
 get time of oldest file in directory. More...

time_t newest () const
 get time of newest file in directory. More...

virtual void save (rs::file::BinaryFile &out) const
 save directory into BinaryFile. More...

virtual void load (rs::file::BinaryFile &in, int version)
 load directory from BinaryFile. More...


Private Attributes

std::string name_
std::set< std::string > files
time_t oldest_
time_t newest_

Detailed Description

class containing all or some files of a directory.

Warning:
You should not use this class directly. Use Directories and scanDir instead - even if you don't want to recurse a whole directory tree.

Definition at line 67 of file Directory.h.


Constructor & Destructor Documentation

Directory   [inline]
 

Create a Directory.

Definition at line 76 of file Directory.h.

virtual ~Directory   [inline, virtual]
 

Definition at line 77 of file Directory.h.


Member Function Documentation

void addFile const std::string &    filename,
time_t    t
 

adds a filename to Directory.

Parameters:
filename  the filename
t  time associated with file (normally time of last modification)

Definition at line 68 of file Directory.cpp.

Referenced by rs::file::scanDir_internal().

void setName const std::string &    dirname [inline]
 

change directory name.

Parameters:
dirname  new name of directory

Definition at line 86 of file Directory.h.

Referenced by rs::file::scanDir_internal().

const std::string& name   const [inline]
 

get name of directory.

Definition at line 89 of file Directory.h.

Referenced by Directory::fullPath(), and rs::file::loadDirectories().

size_t size   const [inline]
 

get number of files in directory.

Definition at line 92 of file Directory.h.

std::set<std::string>::const_iterator begin   const [inline]
 

iterator for files in directory.

Definition at line 95 of file Directory.h.

std::set<std::string>::const_iterator end   const [inline]
 

iterator for files in directory.

Definition at line 97 of file Directory.h.

string fullPath const std::string &    filename const
 

return full path name of a file.

Parameters:
filename  of the file
Returns:
full path of file with directory name

Definition at line 57 of file Directory.cpp.

time_t oldest   const [inline]
 

get time of oldest file in directory.

Definition at line 105 of file Directory.h.

time_t newest   const [inline]
 

get time of newest file in directory.

Definition at line 107 of file Directory.h.

void save rs::file::BinaryFile   out const [virtual]
 

save directory into BinaryFile.

Implements BinaryStoreable.

Definition at line 85 of file Directory.cpp.

Referenced by rs::file::saveDirectories().

void load rs::file::BinaryFile   in,
int    version
[virtual]
 

load directory from BinaryFile.

Implements BinaryStoreable.

Definition at line 97 of file Directory.cpp.

Referenced by rs::file::loadDirectories().


Member Data Documentation

std::string name_ [private]
 

Definition at line 69 of file Directory.h.

Referenced by Directory::load(), Directory::name(), Directory::save(), and Directory::setName().

std::set<std::string> files [private]
 

Definition at line 70 of file Directory.h.

Referenced by Directory::addFile(), Directory::begin(), Directory::end(), Directory::load(), Directory::save(), and Directory::size().

time_t oldest_ [private]
 

Definition at line 71 of file Directory.h.

Referenced by Directory::addFile(), Directory::Directory(), Directory::load(), Directory::oldest(), and Directory::save().

time_t newest_ [private]
 

Definition at line 72 of file Directory.h.

Referenced by Directory::addFile(), Directory::Directory(), Directory::load(), Directory::newest(), and Directory::save().


The documentation for this class was generated from the following files:
Contact me in case of errors or questions.
This documentation is powered by Doxygen.
(C) 2000-2002 Doxygen