FIFE::VFSSource Class Reference

#include <vfssource.h>

Inheritance diagram for FIFE::VFSSource:
Inheritance graph
[legend]
Collaboration diagram for FIFE::VFSSource:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual bool fileExists (const std::string &file) const =0
VFSgetVFS () const
virtual RawDataopen (const std::string &file) const =0
virtual std::set< std::string > listFiles (const std::string &path) const =0
virtual std::set< std::string > listDirectories (const std::string &path) const =0

Detailed Description

VFSSource abstract baseclass

VFSSources are used to provide transparent access to diffrent archives/filesystems etc. Examples are VFSHostSystem

See also:
VFS
VFSSourceProvider

Definition at line 46 of file vfssource.h.


Member Function Documentation

virtual bool FIFE::VFSSource::fileExists ( const std::string &  file  )  const [pure virtual]

check if the given file exists

Parameters:
file filename to check
Returns:
true if it exists, false otherwise

Implemented in FIFE::DAT1, FIFE::DAT2, FIFE::VFSDirectory, and FIFE::ZipSource.

VFS* FIFE::VFSSource::getVFS (  )  const [inline]

get the VFS this source is associated with.

Definition at line 60 of file vfssource.h.

Referenced by FIFE::DAT2::open(), and FIFE::DAT1::open().

Here is the caller graph for this function:

virtual std::set<std::string> FIFE::VFSSource::listDirectories ( const std::string &  path  )  const [pure virtual]

list all directories in a directory of this source

Parameters:
path path to list directories in Will return an empty list on any error

Implemented in FIFE::DAT1, FIFE::DAT2, FIFE::VFSDirectory, and FIFE::ZipSource.

virtual std::set<std::string> FIFE::VFSSource::listFiles ( const std::string &  path  )  const [pure virtual]

list all files in a directory of this source

Parameters:
path path to list files in Will return an empty list on any error

Implemented in FIFE::DAT1, FIFE::DAT2, FIFE::VFSDirectory, and FIFE::ZipSource.

virtual RawData* FIFE::VFSSource::open ( const std::string &  file  )  const [pure virtual]

open a file inside this source

Parameters:
file the file to open
Returns:
a new RawData*
Exceptions:
CannotOpenFile if the file can't be found

Implemented in FIFE::DAT1, FIFE::DAT2, FIFE::VFSDirectory, and FIFE::ZipSource.

Referenced by FIFE::VFS::open().

Here is the caller graph for this function:


The documentation for this class was generated from the following files:
Generated on Wed Nov 23 13:05:11 2011 for FIFE by  doxygen 1.6.3