Torque::FS::FileNode

Engine/source/core/volume.h

Inheritance diagram for Torque::FS::FileNode ↕

Base class for objects in a FileSystem.

More...

Classes:

class

Torque::FS::FileNode::Attributes

Public Types

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
}

enum

NodeStatus {
  Open 
  Closed 
  EndOfFile 
  UnknownError 
  FileSystemFull 
  NoSuchFile 
  AccessDenied 
  IllegalCall 
  SharingViolation 
  NoDisk 
  DriveOpen 
  WrongDisk 
}

Private Attributes

U32

mChecksum

Torque::Time

mLastChecksum

Public Functions

FileNode()

bool

getAttributes(Attributes * )

U32

getChecksum()

Time

getModifiedTime()

Path

getName()

U64

getSize()

NodeStatus

getStatus()

Protected Functions

U32

calculateChecksum()

return 0 on failure

Detailed Description

Base class for objects in a FileSystem.

This class provides the functionality required by all file system files, which is basically name and attributes.

Public Types

Mode

Enumerator

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.

NodeStatus

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.

Private Attributes

U32 mChecksum

Torque::Time mLastChecksum

Public Functions

FileNode()

getAttributes(Attributes * )

Reimplemented by: Torque::Mem::MemFile, Torque::Mem::MemDirectory, Torque::Posix::PosixFile, Torque::Posix::PosixDirectory, Torque::Win32::Win32File, Torque::Win32::Win32Directory, Torque::ZipFileNode, Torque::ZipDirectoryNode, Torque::ZipFakeRootNode

getChecksum()

note:
This will return 0 on failure

getModifiedTime()

note:
This will return Time() on failure

getName()

Reimplemented by: Torque::Mem::MemFile, Torque::Mem::MemDirectory, Torque::ZipFileNode, Torque::ZipDirectoryNode, Torque::ZipFakeRootNode, Torque::Posix::PosixFile, Torque::Posix::PosixDirectory, Torque::Win32::Win32File, Torque::Win32::Win32Directory

getSize()

note:
This will return 0 on failure

Reimplemented by: Torque::Win32::Win32File

getStatus()

Protected Functions

calculateChecksum()

return 0 on failure