Win32BIGFile Class Reference

#include <Win32BIGFile.h>

Inherits ArchiveFile.

Public Member Functions
	Win32BIGFile ()
virtual	~Win32BIGFile ()
virtual Bool	getFileInfo (const AsciiString &filename, FileInfo *fileInfo) const
	fill in the fileInfo struct with info about the requested file.
virtual File *	openFile (const Char *filename, Int access=0)
	Open the specified file within the BIG file.
virtual void	closeAllFiles (void)
	Close all file opened in this BIG file.
virtual AsciiString	getName (void)
	Returns the name of the BIG file.
virtual AsciiString	getPath (void)
	Returns full path and name of BIG file.
virtual void	setSearchPriority (Int new_priority)
	Set this BIG file's search priority.
virtual void	close (void)
	Close this BIG file.
Public Member Functions inherited from ArchiveFile
	ArchiveFile ()
virtual	~ArchiveFile ()
void	attachFile (File *file)
void	getFileListInDirectory (const AsciiString &currentDirectory, const AsciiString &originalDirectory, const AsciiString &searchName, FilenameList &filenameList, Bool searchSubdirectories) const
void	getFileListInDirectory (const DetailedArchivedDirectoryInfo *dirInfo, const AsciiString &currentDirectory, const AsciiString &searchName, FilenameList &filenameList, Bool searchSubdirectories) const
void	addFile (const AsciiString &path, const ArchivedFileInfo *fileInfo)
	add this file to our directory tree.

Protected Attributes
AsciiString	m_name
	BIG file name.
AsciiString	m_path
	BIG file path.
Protected Attributes inherited from ArchiveFile
File *	m_file
	file pointer to the archive file on disk. Kept open so we don't have to continuously open and close the file all the time.
DetailedArchivedDirectoryInfo	m_rootDirectory

Additional Inherited Members
Protected Member Functions inherited from ArchiveFile
const ArchivedFileInfo *	getArchivedFileInfo (const AsciiString &filename) const
	return the ArchivedFileInfo from the directory tree.

Detailed Description

Definition at line 38 of file Win32BIGFile.h.

Constructor & Destructor Documentation

Win32BIGFile()

Win32BIGFile::Win32BIGFile

(

)

Definition at line 41 of file Win32BIGFile.cpp.

~Win32BIGFile()

Win32BIGFile::~Win32BIGFile ( )

virtual

Definition at line 50 of file Win32BIGFile.cpp.

Member Function Documentation

close()

void Win32BIGFile::close ( void )

virtual

Close this BIG file.

Implements ArchiveFile.

Definition at line 140 of file Win32BIGFile.cpp.

closeAllFiles()

void Win32BIGFile::closeAllFiles ( void )

virtual

Close all file opened in this BIG file.

Implements ArchiveFile.

Definition at line 104 of file Win32BIGFile.cpp.

getFileInfo()

Bool Win32BIGFile::getFileInfo ( const AsciiString & filename, FileInfo * fileInfo ) const

virtual

fill in the fileInfo struct with info about the requested file.

Implements ArchiveFile.

Definition at line 149 of file Win32BIGFile.cpp.

getName()

AsciiString Win32BIGFile::getName ( void )

virtual

Returns the name of the BIG file.

Implements ArchiveFile.

Definition at line 113 of file Win32BIGFile.cpp.

getPath()

AsciiString Win32BIGFile::getPath ( void )

virtual

Returns full path and name of BIG file.

Implements ArchiveFile.

Definition at line 122 of file Win32BIGFile.cpp.

openFile()

File * Win32BIGFile::openFile ( const Char * filename, Int access = 0 )

virtual

Open the specified file within the BIG file.

Implements ArchiveFile.

Definition at line 59 of file Win32BIGFile.cpp.

setSearchPriority()

void Win32BIGFile::setSearchPriority ( Int new_priority )

virtual

Set this BIG file's search priority.

Implements ArchiveFile.

Definition at line 131 of file Win32BIGFile.cpp.

Member Data Documentation

m_name

AsciiString Win32BIGFile::m_name

protected

BIG file name.

Definition at line 54 of file Win32BIGFile.h.

m_path

AsciiString Win32BIGFile::m_path

protected

BIG file path.

Definition at line 55 of file Win32BIGFile.h.

---

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

• Code/GameEngineDevice/Include/Win32Device/Common/Win32BIGFile.h
• Code/GameEngineDevice/Source/Win32Device/Common/Win32BIGFile.cpp