Platform_NULL_FileSystem Class Reference

Inheritance diagram for Platform_NULL_FileSystem:

List of all members.

Public Member Functions
	Platform_NULL_FileSystem ()
virtual void	SetLogging (bool enabled)
virtual Platform_FileSystem_Directory *	CreateDirectoryObject (const char *path)
virtual Platform_FileSystem_File *	CreateFileObject (const char *path)
virtual void	RescanDevices ()
virtual int	GetDeviceCount ()
virtual const Platform_FileSystem_Device *	GetDevice (int index)

---

Detailed Description

Author:

Mattias Gustavsson

Definition at line 19 of file Platform_NULL_FileSystem.h.

---

Constructor & Destructor Documentation

Platform_NULL_FileSystem::Platform_NULL_FileSystem

(

)

Definition at line 10 of file Platform_NULL_FileSystem.cpp.

---

Member Function Documentation

void Platform_NULL_FileSystem::SetLogging

(

bool

enabled

)

[virtual]

Sometimes, for debug purposes, it might be useful to find out where and when things are loaded. If logging is enabled (it is disabled by default) a debug text string will be written every time a file or directory object is requested through the Platform_FileSystem, including the full path of the file/directory.

Implements Platform_FileSystem.

Definition at line 17 of file Platform_NULL_FileSystem.cpp.

Platform_FileSystem_Directory * Platform_NULL_FileSystem::CreateDirectoryObject

(

const char *

path

)

[virtual]

Creates a platform independent directory object corresponding to the specified path. The directory may or may not exist - the directory object is merely representational, and can be queried for whether the directory exists or not, and used to create/delete it as necessary.

The returned object needs to be destroyed by the caller (using the delete keyword) when it is no longer needed.

The path can be a full or relative path, with directories separated by a forward slash (/). It is up to the platform specific implementation to replace these separators with whatever is used on that platform.

Returns:

A new Platform_FileSystem_Directory object representing the directory

Implements Platform_FileSystem.

Definition at line 24 of file Platform_NULL_FileSystem.cpp.

Platform_FileSystem_File * Platform_NULL_FileSystem::CreateFileObject

(

const char *

path

)

[virtual]

Creates a platform independent file object corresponding to the specified path. The file may or may not exist - the file object is merely representational, and can be queried for whether the file exists or not, and used to create, open or delete the file as necessary.

The returned object needs to be destroyed by the caller (using the delete keyword) when it is no longer needed.

The path can be a full or relative path, with directories separated by a forward slash (/). It is up to the platform specific implementation to replace these separators with whatever is used on that platform.

Returns:

A new Platform_FileSystem_File object representing the file

Implements Platform_FileSystem.

Definition at line 32 of file Platform_NULL_FileSystem.cpp.

void Platform_NULL_FileSystem::RescanDevices

(

)

[virtual]

When Platform_FileSystem is created, it makes an internal list of the devices that are present in the system. This list can be updated by a call to this method, if you have reason to believe that the available devices have changed.

Implements Platform_FileSystem.

Definition at line 40 of file Platform_NULL_FileSystem.cpp.

int Platform_NULL_FileSystem::GetDeviceCount

(

)

[virtual]

Retrieves the number of available devices for the system

Returns:

The number of available devices

Implements Platform_FileSystem.

Definition at line 47 of file Platform_NULL_FileSystem.cpp.

const Platform_FileSystem_Device * Platform_NULL_FileSystem::GetDevice

(

int

index

)

[virtual]

Retrieves the device with the specified index, from 0 to the value returned by GetDeviceCount. The object returned is owned and controlled by Platform_FileSystem, and shouldn't be deleted by the caller

Returns:

A device object representing the device at the specified index

Implements Platform_FileSystem.

Definition at line 55 of file Platform_NULL_FileSystem.cpp.