Torque 3D 3.8
ContentsIndexHome
PreviousUpNext
Torque::FS Namespace

This is namespace Torque::FS.

Name 
Description 
The following table lists classes in this documentation. 
The following table lists functions in this documentation. 
The following table lists types in this documentation. 
The following table lists variables in this documentation. 
 
Name 
Description 
 
Directory in a FileSystem. Directory object in a FileSystem. When a directory is initially obtained from a FileSystem it is in a closed state. @ingroup VolumeSystem 
 
File 
File object in a FileSystem. File object in a FileSystem. When a file is initially obtained from a FileSystem it is in a closed state. @ingroup VolumeSystem 
 
Base class for all FileIO objects. @ingroup VolumeSystem 
 
Base class for objects in a FileSystem. This class provides the functionality required by all file system files, which is basically name and attributes. @ingroup VolumeSystem 
 
Collection of FileNode objects. File systems represent collections of FileNode objects. Functions are provided for manipulating FileNode objects but the internal organization and representation is opaque. Path names must be fully specified relative to the file system root and names cannot contain relative path information. @ingroup VolumeSystem 
 
This is class Torque::FS::FileSystemChangeNotifier. 
 
@name File System Access A collection of file systems. @ingroup VolumeSystem 
 
The VirtualMountSystem extend the mount system by allowing you to mount and access multiple filesystems on a single root. This allows you to mount multiple volume files on a single root without needing to change source paths that reference those volumes to use new roots. For instance, you could mount "missions1.zip" and "missions2.zip", on the same root "", and you could access files from either one.
If you need to mount a writeable filesystem on a VMS, you should mount it as the first filesystem on a root. File writes are handled as follows: 1) If you try to open... more 
 
Name 
Description 
 
Compare modified times of p1 & p2 @return -1 if p1 < p2, 0 if p1 == p2, 1 if p1 > p2 
 
Create a directory. The directory object is returned in a closed state. @ingroup VolumeSystem 
 
Create a file. The file object is returned in a closed state. @ingroup VolumeSystem 
 
Create all the directories in the path if they don't already exist @ingroup VolumeSystem 
 
Find files matching a pattern starting in a given dir. @param inBasePath path to start in @param inFilePattern the file pattern [it uses the FindMatch class] @param inRecursive do we search recursively? @param outList the list of files as Strings [Paths are more expensive to compute, so these may be converted on demand] @param multiMatch match against multiple file patterns given in inFilePattern? @return number of files which matched @ingroup VolumeSystem 
 
Get the current working directory. @ingroup VolumeSystem 
 
Get the file attributes. @return success @ingroup VolumeSystem 
 
Find the file system node for the given file. @return Null if the file doesn't exist @ingroup VolumeSystem 
 
Find the the file system which owns the given file. @ingroup VolumeSystem 
 
Returns a true file system path without virtual mounts.
@param inPath The path to convert. @param outPath The resulting real file system path. 
 
This is function Torque::FS::GetMountPath. 
 
This is function Torque::FS::GetMountRoot. 
 
This is function Torque::FS::GetMountType. 
 
This is function Torque::FS::GetNumMounts. 
 
This is function Torque::FS::IsDirectory. 
 
This is function Torque::FS::IsFile. 
 
This is function Torque::FS::IsReadOnly. 
 
This returns a unique file path from the components by appending numbers to the end of the file name if a file with the same name already exists.
@param path The root and directory for the file. @param fileName The file name without extension. @param ext The dot-less extension. 
 
Map a real file system path to a virtual one based on a root. This is useful when we get a real path back from an OS file dialog for example. e.g. If we have a root "gumby" which points at "C:/foo/bar", MapFSPath("gumby", "C:/foo/bar/blat/picture.png", path ); will map "C:/foo/bar/blat/picture.png" to "gumby:/blat/picture.png" @param inRoot The root to check @param inPath The real file system path @param outPath The resulting volume system path @return Success or failure 
 
Mount file system @ingroup VolumeSystem 
 
Mount file system redirect @ingroup VolumeSystem 
 
Open a directory. If the directory exists a directory object will be returned even if the open operation fails. @return Null if the file does not exist @ingroup VolumeSystem 
 
Open a file. If the file exists a file object will be returned even if the open operation fails. @return Null if the file does not exist @ingroup VolumeSystem 
 
Read in an entire file @note Caller is responsible for freeing memory @param inPath the file @param outData the pointer to return the data @param outSize the size of the data returned @param inNullTerminate add an extra '0' byte to the return buffer @return successful read? If not, outData will be NULL and outSize will be 0 
 
Remove (or delete) a file from the file system. @ingroup VolumeSystem 
 
Rename a file or directory. @ingroup VolumeSystem 
 
Set current working directory. @ingroup VolumeSystem 
 
This is function Torque::FS::StartFileChangeNotifications. 
 
This is function Torque::FS::StopFileChangeNotifications. 
 
Remove mounted file system. Open files associated with this file system are unaffected. @return true if the filesystem was successfully unmounted, false otherwise (most likely, the FS was not mounted) 
 
Remove mounted file system. The file system object associated with the given root is unmounted. Open files associated with this file system are unaffected. @return The unmounted file system. @ingroup VolumeSystem 
 
Name 
Description 
This is type Torque::FS::DirectoryPtr. 
This is type Torque::FS::DirectoryRef. 
This is type Torque::FS::FileNodePtr. 
This is type Torque::FS::FileNodeRef. 
This is type Torque::FS::FilePtr. 
This is type Torque::FS::FileRef. 
This is type Torque::FS::FileSystemPtr. 
This is type Torque::FS::FileSystemRef. 
Name 
Description 
This is variable Torque::FS::gVMSVerboseLog. 
Copyright (c) 2015. All rights reserved.
What do you think about this topic? Send feedback!