C:/quickbuild-1.2.13/working/root/Docs/TGEA_Offline_Docs/checkouts/engine/source/core/volume.h File Reference

#include "core/util/tSignal.h"
#include "core/util/tVector.h"
#include "core/util/refBase.h"
#include "core/util/tDictionary.h"
#include "core/util/tList.h"
#include "core/util/path.h"
#include "core/util/timeClass.h"

Namespaces

namespace  Torque
namespace  Torque::FS

Classes

class  Torque::FS::FileBase
 Base class for all FileIO objects. More...
class  Torque::FS::FileNode
 Base class for objects in a FileSystem. More...
struct  Torque::FS::FileNode::Attributes
class  Torque::FS::File
 File object in a FileSystem. More...
class  Torque::FS::Directory
 Directory in a FileSystem. More...
class  Torque::FS::FileSystemChangeNotifier
struct  Torque::FS::FileSystemChangeNotifier::FileInfo
class  Torque::FS::FileSystem
 Collection of FileNode objects. More...
class  Torque::FS::MountSystem
struct  Torque::FS::MountSystem::MountFS
class  Torque::FS::MountSystem::MountList

File System Access

Functions for mounting file systems and dealing with files and directories. The kernel provides FileSystem mounting, the concept of a current working directory as well as relative paths.

bool Torque::FS::Mount (String root, FileSystemRef fs)
 Mount file system.
bool Torque::FS::Mount (String root, const Path &path)
 Mount file system redirect.
FileSystemRef Torque::FS::Unmount (String root)
 Remove mounted file system.
FileSystemRef Torque::FS::GetFileSystem (const Path &file)
 Find the the file system which owns the given file.
FileNodeRef Torque::FS::GetFileNode (const Path &path)
 Find the file system node for the given file.
bool Torque::FS::MapFSPath (const String &inRoot, const Path &inPath, Path &outPath)
 Map a real file system path to a virtual one based on a root.
S32 Torque::FS::FindByPattern (const Path &inBasePath, const String &inFilePattern, bool inRecursive, Vector< String > &outList)
 Find files matching a pattern starting in a given dir.
bool Torque::FS::SetCwd (const Path &file)
 Set current working directory.
const PathTorque::FS::GetCwd ()
 Get the current working directory.
bool Torque::FS::Remove (const Path &file)
 Remove (or delete) a file from the file system.
bool Torque::FS::Rename (const Path &from, const Path &to)
 Rename a file or directory.
bool Torque::FS::GetFileAttributes (const Path &path, FileNode::Attributes *attr)
 Get the file attributes.
FileRef Torque::FS::OpenFile (const Path &file, File::AccessMode mode)
 Open a file.
bool Torque::FS::ReadFile (const Path &inPath, void *&outData, U32 &outSize, bool inNullTerminate=false)
 Read in an entire file.
DirectoryRef Torque::FS::OpenDirectory (const Path &file)
 Open a directory.
FileRef Torque::FS::CreateFile (const Path &file)
 Create a file.
DirectoryRef Torque::FS::CreateDirectory (const Path &file)
 Create a directory.
bool Torque::FS::CreatePath (const Path &path)
 Create all the directories in the path if they don't already exist.
bool Torque::FS::IsReadOnly (const Path &path)
bool Torque::FS::IsDirectory (const Path &path)
bool Torque::FS::IsFile (const Path &path)
void Torque::FS::StartFileChangeNotifications ()
void Torque::FS::StopFileChangeNotifications ()
S32 Torque::FS::GetNumMounts ()
String Torque::FS::GetMountRoot (S32 index)
String Torque::FS::GetMountPath (S32 index)
String Torque::FS::GetMountType (S32 index)

Typedefs

typedef WeakRefPtr< FileNode > Torque::FS::FileNodePtr
typedef StrongRefPtr< FileNode > Torque::FS::FileNodeRef
typedef WeakRefPtr< FileTorque::FS::FilePtr
typedef StrongRefPtr< FileTorque::FS::FileRef
typedef WeakRefPtr< Directory > Torque::FS::DirectoryPtr
typedef StrongRefPtr< Directory > Torque::FS::DirectoryRef
typedef WeakRefPtr< FileSystem > Torque::FS::FileSystemPtr
typedef StrongRefPtr< FileSystem > Torque::FS::FileSystemRef