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

Ogre::HttpArchive Class Reference

Specialisation of the Archive class to allow reading of files from http servers. More...

#include <EmmaOgreHttp.h>

List of all members.

Public Member Functions

 HttpArchive (const String &name, const String &archType)
 ~HttpArchive ()
bool isCaseSensitive (void) const
void load ()
void unload ()
DataStreamPtr open (const String &filename) const
StringVectorPtr list (bool recursive=true)
FileInfoListPtr listFileInfo (bool recursive=true)
StringVectorPtr find (const String &pattern, bool recursive=true)
FileInfoListPtr findFileInfo (const String &pattern, bool recursive=true)
bool exists (const String &filename)

Protected Types

typedef std::deque< String > DirectoryStack
 Directory stack of previous directories.

Protected Member Functions

void findFiles (const String &pattern, bool recursive, StringVector *simpleList, FileInfoList *detailList, const String &currentDir="")
 Utility method to retrieve all files in a directory matching pattern.
void changeDirectory (const String &dir) const
 Utility method to change the current directory.
void pushDirectory (const String &dir) const
 Utility method to change directory and push the current directory onto a stack.
void popDirectory (void) const
 Utility method to pop a previous directory off the stack and change to it.

Protected Attributes

String mBasePath
 Base path; actually the same as mName, but for clarity.
DirectoryStack mDirectoryStack
char mTmpPath [OGRE_MAX_PATH]
 temporary C-string to retrieve paths


Detailed Description

Specialisation of the Archive class to allow reading of files from http servers.


Member Typedef Documentation

typedef std::deque<String> Ogre::HttpArchive::DirectoryStack [protected]
 

Directory stack of previous directories.


Constructor & Destructor Documentation

Ogre::HttpArchive::HttpArchive const String &  name,
const String &  archType
 

Ogre::HttpArchive::~HttpArchive  ) 
 


Member Function Documentation

void Ogre::HttpArchive::changeDirectory const String &  dir  )  const [protected]
 

Utility method to change the current directory.

bool Ogre::HttpArchive::exists const String &  filename  ) 
 

StringVectorPtr Ogre::HttpArchive::find const String &  pattern,
bool  recursive = true
 

FileInfoListPtr Ogre::HttpArchive::findFileInfo const String &  pattern,
bool  recursive = true
 

void Ogre::HttpArchive::findFiles const String &  pattern,
bool  recursive,
StringVector *  simpleList,
FileInfoList *  detailList,
const String &  currentDir = ""
[protected]
 

Utility method to retrieve all files in a directory matching pattern.

Parameters:
pattern File pattern
recursive Whether to cascade down directories
simpleList Populated if retrieving a simple list
detailList Populated if retrieving a detailed list
currentDir The current directory relative to the base of the archive, for file naming

bool Ogre::HttpArchive::isCaseSensitive void   )  const
 

StringVectorPtr Ogre::HttpArchive::list bool  recursive = true  ) 
 

FileInfoListPtr Ogre::HttpArchive::listFileInfo bool  recursive = true  ) 
 

void Ogre::HttpArchive::load  ) 
 

DataStreamPtr Ogre::HttpArchive::open const String &  filename  )  const
 

void Ogre::HttpArchive::popDirectory void   )  const [protected]
 

Utility method to pop a previous directory off the stack and change to it.

void Ogre::HttpArchive::pushDirectory const String &  dir  )  const [protected]
 

Utility method to change directory and push the current directory onto a stack.

void Ogre::HttpArchive::unload  ) 
 


Member Data Documentation

String Ogre::HttpArchive::mBasePath [protected]
 

Base path; actually the same as mName, but for clarity.

DirectoryStack Ogre::HttpArchive::mDirectoryStack [mutable, protected]
 

char Ogre::HttpArchive::mTmpPath[OGRE_MAX_PATH] [mutable, protected]
 

temporary C-string to retrieve paths


The documentation for this class was generated from the following file:
Generated on Sat Apr 1 06:08:36 2006 for Emma SDK Guide by  doxygen 1.4.3