LocalFileSystem Class Reference

#include <LocalFileSystem.h>

Inherits SubsystemInterface.

Inherited by Win32LocalFileSystem.

Public Member Functions
virtual	~LocalFileSystem ()
virtual void	init ()=0
virtual void	reset ()=0
virtual void	update ()=0
virtual File *	openFile (const Char *filename, Int access=0)=0
virtual Bool	doesFileExist (const Char *filename) const =0
virtual void	getFileListInDirectory (const AsciiString &currentDirectory, const AsciiString &originalDirectory, const AsciiString &searchName, FilenameList &filenameList, Bool searchSubdirectories) const =0
	search the given directory for files matching the searchName (egs. *.ini, *.rep). Possibly search subdirectories.
virtual Bool	getFileInfo (const AsciiString &filename, FileInfo *fileInfo) const =0
	see FileSystem.h
virtual Bool	createDirectory (AsciiString directory)=0
	see FileSystem.h
Public Member Functions inherited from SubsystemInterface
	SubsystemInterface ()
virtual	~SubsystemInterface ()
virtual void	postProcessLoad ()
virtual void	draw (void)
void	UPDATE (void)
void	DRAW (void)
AsciiString	getName (void)
void	setName (AsciiString name)

Additional Inherited Members
Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

Definition at line 39 of file LocalFileSystem.h.

Constructor & Destructor Documentation

~LocalFileSystem()

virtual LocalFileSystem::~LocalFileSystem ( )

inlinevirtual

Definition at line 42 of file LocalFileSystem.h.

Member Function Documentation

createDirectory()

virtual Bool LocalFileSystem::createDirectory ( AsciiString directory )

pure virtual

see FileSystem.h

Implemented in Win32LocalFileSystem.

doesFileExist()

virtual Bool LocalFileSystem::doesFileExist ( const Char * filename ) const

pure virtual

Implemented in Win32LocalFileSystem.

getFileInfo()

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

pure virtual

see FileSystem.h

Implemented in Win32LocalFileSystem.

getFileListInDirectory()

virtual void LocalFileSystem::getFileListInDirectory ( const AsciiString & currentDirectory, const AsciiString & originalDirectory, const AsciiString & searchName, FilenameList & filenameList, Bool searchSubdirectories ) const

pure virtual

search the given directory for files matching the searchName (egs. *.ini, *.rep). Possibly search subdirectories.

Implemented in Win32LocalFileSystem.

init()

void LocalFileSystem::init ( )

pure virtual

• Assign any default values to data required for the class
  • Allocate any memory and resources needed throughout the lifetime of the class

Implements SubsystemInterface.

Implemented in Win32LocalFileSystem.

Definition at line 96 of file LocalFileSystem.cpp.

openFile()

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

pure virtual

Implemented in Win32LocalFileSystem.

reset()

void LocalFileSystem::reset ( )

pure virtual

• Any system should be able to reset all data and go back to an empty state that is ready to accept a completely new set of data. Reset() can expect to be used in the context of resetting the engine in order to start or load a new game.
  • Do NOT free and re-allocate resources needed, where possible reorganize and re-initialize the resources already allocated.
  • After a reset, the system does not need to be in EXACTLY the same state as a fresh instantiation. If there are persistent state information for the system make sure you maintain it while restoring or re-initializing other transient parts.

Implements SubsystemInterface.

Implemented in Win32LocalFileSystem.

Definition at line 99 of file LocalFileSystem.cpp.

update()

void LocalFileSystem::update ( )

pure virtual

• Update methods are the place to do system per frame processing. You should call the system update once each time through the game loop to service the system.
  • Note that currently the GameClient and GameLogic will be updating at different rates where the logic is running real time, and the client will adjust how many loops can be done during one server time slice in order to improve performance on low end machines.

Implements SubsystemInterface.

Implemented in Win32LocalFileSystem.

Definition at line 102 of file LocalFileSystem.cpp.

---

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

• Code/GameEngine/Include/Common/LocalFileSystem.h
• Code/GameEngine/Source/Common/System/LocalFileSystem.cpp