Main Page | Modules | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages

SLDirectory Class Reference
[segusoland C++ Library]

this class holds a directory (without the leading /) More...

#include <SLDirectory.hpp>

Inheritance diagram for SLDirectory:

Inheritance graph
[legend]
Collaboration diagram for SLDirectory:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 SLDirectory (const char *path)
const SLFileListgetFiles () throw (IOException)
SLDirectoryListgetDirectories () throw (IOException)

Protected Member Functions

void scanDir () throw (IOException)

Protected Attributes

boost::shared_ptr< DirData > _dir_shared_ptr

Detailed Description

this class holds a directory (without the leading /)

Author:
Alexandre Sauve
See also:
SLFile
Directories are mainly specialized Files


Constructor & Destructor Documentation

SLDirectory::SLDirectory const char *  path  ) 
 

See also:
SLFile::SLFile This constructor takes the same arguments as a SLFile object.
It may NOT have a '/' char at the end.


Member Function Documentation

SLDirectoryList& SLDirectory::getDirectories  )  throw (IOException)
 

Reads a directory and returns its unsorted content with "no recursion".

Returns:
A directory list, not the files.
See also:
SLDirectory::getFiles()
The result is cached, so multiple calls do not require extra work and are fast. The drawback is more memory is consumed if you keep all SLDirectories. However, the directory is red only if this method is called...

const SLFileList& SLDirectory::getFiles  )  throw (IOException)
 

Reads a directory and returns its unsorted content with "no recursion".

Returns:
A file list, not the directories.
See also:
SLDirectory::getDirectories()
The result is cached, so multiple calls do not require extra work and are fast. The drawback is more memory is consumed if you keep all SLDirectories. However, the directory is red only if this method is called...

void SLDirectory::scanDir  )  throw (IOException) [protected]
 

Used to load files list from this directory.


Member Data Documentation

boost::shared_ptr<DirData> SLDirectory::_dir_shared_ptr [protected]
 

Used to store directory specific data (cache for file listings).


The documentation for this class was generated from the following file:
Generated on Mon Apr 19 01:03:35 2004 for segusoLand by doxygen 1.3.6-20040222