SO3ScolFileSystemArchive Class Reference

#include <SO3ScolFileSystem.h>

List of all members.

Public Member Functions
	SO3ScolFileSystemArchive (const Ogre::String &name, const Ogre::String &archType)
	~SO3ScolFileSystemArchive ()
bool	isCaseSensitive () const
void	load ()
void	unload ()
Ogre::DataStreamPtr	open (const Ogre::String &filename) const
Ogre::StringVectorPtr	list (bool recursive=true, bool dirs=false)
Ogre::FileInfoListPtr	listFileInfo (bool recursive=true, bool dirs=false)
Ogre::StringVectorPtr	find (const Ogre::String &pattern, bool recursive=true, bool dirs=false)
Ogre::FileInfoListPtr	findFileInfo (const Ogre::String &pattern, bool recursive=true, bool dirs=false)
bool	exists (const Ogre::String &filename)
time_t	getModifiedTime (const Ogre::String &filename)
Protected Member Functions
void	findFiles (const Ogre::String &pattern, bool recursive, bool dirs, Ogre::StringVector *simpleList, Ogre::FileInfoList *detailList)
bool	is_reserved_dir (const char *fn)
Ogre::String	scolToAbsolutePath (const Ogre::String &base, const Ogre::String &name) const
bool	is_absolute_path (const char *path) const
Protected Attributes
Ogre::String	scolPartitionPath

---

Detailed Description

SO3ScolFileSystem.h : Scol FileSystem (partitions) archive managing

Specialisation of the Archive class to allow reading of files from Scol partitions folders / directories if a relative path is used, or from the disk filesystem if a fullpath is used.

Definition at line 42 of file SO3ScolFileSystem.h.

---

Constructor & Destructor Documentation

SO3ScolFileSystemArchive::SO3ScolFileSystemArchive	(	const Ogre::String &	name,
		const Ogre::String &	archType
	)

Constructor

SO3ScolFileSystem.cpp : Scol FileSystem (partitions) archive managing

Definition at line 37 of file SO3ScolFileSystem.cpp.

SO3ScolFileSystemArchive::~SO3ScolFileSystemArchive

(

)

Destructor

Definition at line 187 of file SO3ScolFileSystem.cpp.

---

Member Function Documentation

bool SO3ScolFileSystemArchive::exists

(

const Ogre::String &

filename )

Definition at line 282 of file SO3ScolFileSystem.cpp.

Ogre::StringVectorPtr SO3ScolFileSystemArchive::find	(	const Ogre::String &	pattern,
		bool	recursive = true,
		bool	dirs = false
	)

Definition at line 260 of file SO3ScolFileSystem.cpp.

Ogre::FileInfoListPtr SO3ScolFileSystemArchive::findFileInfo	(	const Ogre::String &	pattern,
		bool	recursive = true,
		bool	dirs = false
	)

Definition at line 271 of file SO3ScolFileSystem.cpp.

void SO3ScolFileSystemArchive::findFiles	(	const Ogre::String &	pattern,
		bool	recursive,
		bool	dirs,
		Ogre::StringVector *	simpleList,
		Ogre::FileInfoList *	detailList
	)		[protected]

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

Parameters:

pattern	File pattern
recursive	Whether to cascade down directories
dirs	Set to true if you want the directories to be listed instead of files
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

Definition at line 97 of file SO3ScolFileSystem.cpp.

time_t SO3ScolFileSystemArchive::getModifiedTime

(

const Ogre::String &

filename )

Definition at line 307 of file SO3ScolFileSystem.cpp.

bool SO3ScolFileSystemArchive::is_absolute_path

(

const char *

path )

const [protected]

Definition at line 77 of file SO3ScolFileSystem.cpp.

bool SO3ScolFileSystemArchive::is_reserved_dir

(

const char *

fn )

[protected]

Check if a directory start with "./" or "../"

Definition at line 71 of file SO3ScolFileSystem.cpp.

bool SO3ScolFileSystemArchive::isCaseSensitive

(

)

const

Definition at line 65 of file SO3ScolFileSystem.cpp.

Ogre::StringVectorPtr SO3ScolFileSystemArchive::list	(	bool	recursive = true,
		bool	dirs = false
	)

Definition at line 237 of file SO3ScolFileSystem.cpp.

Ogre::FileInfoListPtr SO3ScolFileSystemArchive::listFileInfo	(	bool	recursive = true,
		bool	dirs = false
	)

Definition at line 249 of file SO3ScolFileSystem.cpp.

void SO3ScolFileSystemArchive::load

(

)

Definition at line 193 of file SO3ScolFileSystem.cpp.

Ogre::DataStreamPtr SO3ScolFileSystemArchive::open

(

const Ogre::String &

filename )

const

Definition at line 207 of file SO3ScolFileSystem.cpp.

Ogre::String SO3ScolFileSystemArchive::scolToAbsolutePath	(	const Ogre::String &	base,
		const Ogre::String &	name
	)		const [protected]

Definition at line 86 of file SO3ScolFileSystem.cpp.

void SO3ScolFileSystemArchive::unload

(

)

Definition at line 199 of file SO3ScolFileSystem.cpp.

---

Member Data Documentation

Ogre::String SO3ScolFileSystemArchive::scolPartitionPath [protected]

Definition at line 46 of file SO3ScolFileSystem.h.

---

The documentation for this class was generated from the following files:

• SO3Engine/SO3Utils/SO3ScolFileSystem.h
• SO3Engine/SO3Utils/SO3ScolFileSystem.cpp