|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Public Types | |
| Open | |
| In an open state. | |
| Closed | |
| In a closed state. | |
| EndOfFile | |
| End of file reached. | |
| UnknownError | |
| An undetermined error has occurred. | |
| FileSystemFull | |
| File system full. | |
| NoSuchFile | |
| File or path does not exist. | |
| AccessDenied | |
| File access denied. | |
| IllegalCall | |
| An unsupported operation was used. | |
| SharingViolation | |
| File being used by another process. | |
| NoDisk | |
| No disk or dvd in drive. | |
| DriveOpen | |
| Disk or DVD drive open. | |
| WrongDisk | |
| Disk or DVD has been swapped. | |
| File = 1 << 0 | |
| Normal file. | |
| Directory = 1 << 1 | |
| Directory. | |
| System = 1 << 2 | |
| OS specific system file. | |
| Hidden = 1 << 3 | |
| Hidden file or directory. | |
| ReadOnly = 1 << 4 | |
| Read only. | |
| Compressed = 1 << 5 | |
| Part of a compressed archive? | |
| Encrypted = 1 << 6 | |
| Part of an encrypted archive? | |
| Library = 1 << 7 | |
| Dynamic Library. | |
| Executable = 1 << 8 | |
| Executable file. | |
| enum | Status { Open, Closed, EndOfFile, UnknownError, FileSystemFull, NoSuchFile, AccessDenied, IllegalCall, SharingViolation, NoDisk, DriveOpen, WrongDisk } |
| enum | Mode { File = 1 << 0, Directory = 1 << 1, System = 1 << 2, Hidden = 1 << 3, ReadOnly = 1 << 4, Compressed = 1 << 5, Encrypted = 1 << 6, Library = 1 << 7, Executable = 1 << 8 } |
Public Member Functions | |
| FileNode () | |
| virtual Path | getName () const =0 |
| virtual Status | getStatus () const =0 |
| virtual bool | getAttributes (Attributes *)=0 |
| virtual Time | getModifiedTime () |
| virtual U64 | getSize () |
| virtual U32 | getChecksum () |
Protected Member Functions | |
| virtual U32 | calculateChecksum ()=0 |
| return 0 on failure | |
Private Attributes | |
| U32 | mChecksum |
| Torque::Time | mLastChecksum |
Classes | |
| struct | Attributes |
Member Enumeration Documentation
- Enumerator:
-
Open In an open state. Closed In a closed state. EndOfFile End of file reached. UnknownError An undetermined error has occurred. FileSystemFull File system full. NoSuchFile File or path does not exist. AccessDenied File access denied. IllegalCall An unsupported operation was used. SharingViolation File being used by another process. NoDisk No disk or dvd in drive. DriveOpen Disk or DVD drive open. WrongDisk Disk or DVD has been swapped.
- Enumerator:
-
File Normal file. Directory Directory. System OS specific system file. Hidden Hidden file or directory. ReadOnly Read only. Compressed Part of a compressed archive? Encrypted Part of an encrypted archive? Library Dynamic Library. Executable Executable file.
Constructor & Destructor Documentation
| Torque::FS::FileNode::FileNode | ( | ) |
Member Function Documentation
| virtual Path Torque::FS::FileNode::getName | ( | ) | const [pure virtual] |
| virtual Status Torque::FS::FileNode::getStatus | ( | ) | const [pure virtual] |
| virtual bool Torque::FS::FileNode::getAttributes | ( | Attributes * | ) | [pure virtual] |
| virtual Time Torque::FS::FileNode::getModifiedTime | ( | ) | [virtual] |
- Note:
- This will return Time() on failure
| virtual U64 Torque::FS::FileNode::getSize | ( | ) | [virtual] |
| virtual U32 Torque::FS::FileNode::getChecksum | ( | ) | [virtual] |
- Note:
- This will return 0 on failure
| virtual U32 Torque::FS::FileNode::calculateChecksum | ( | ) | [protected, pure virtual] |
return 0 on failure
Implemented in Torque::Mem::MemFile, Torque::Mem::MemDirectory, Torque::Posix::PosixFile, Torque::Posix::PosixDirectory, Torque::Win32::Win32File, and Torque::Win32::Win32Directory.
Member Data Documentation
U32 Torque::FS::FileNode::mChecksum [private] |