Torque::FS::File Class Reference [Volume System]

#include <volume.h>

Inheritance diagram for Torque::FS::File:

Inheritance graph
[legend]
List of all members.

Detailed Description

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.


Public Types

 Read = 0
 Open for read only.
 Write = 1
 Open for write only.
 ReadWrite = 2
 Open for read-write.
 WriteAppend = 3
 Write-only, starting at end of file.
 Begin
 Relative to the start of the file.
 Current
 Relative to the current position.
 End
 Relative to the end of the file.
enum  AccessMode {
  Read = 0,
  Write = 1,
  ReadWrite = 2,
  WriteAppend = 3
}
enum  SeekMode {
  Begin,
  Current,
  End
}

Public Member Functions

 File ()
virtual ~File ()
virtual U32 getPosition ()=0
virtual U32 setPosition (U32 pos, SeekMode mode)=0
virtual bool open (AccessMode mode)=0
virtual bool close ()=0
virtual U32 read (void *dst, U32 size)=0
virtual U32 write (const void *src, U32 size)=0


Member Enumeration Documentation

Enumerator:
Read  Open for read only.
Write  Open for write only.
ReadWrite  Open for read-write.
WriteAppend  Write-only, starting at end of file.

Enumerator:
Begin  Relative to the start of the file.
Current  Relative to the current position.
End  Relative to the end of the file.


Constructor & Destructor Documentation

Torque::FS::File::File (  ) 

virtual Torque::FS::File::~File (  )  [virtual]


Member Function Documentation

virtual U32 Torque::FS::File::getPosition (  )  [pure virtual]

virtual U32 Torque::FS::File::setPosition ( U32  pos,
SeekMode  mode 
) [pure virtual]

virtual bool Torque::FS::File::open ( AccessMode  mode  )  [pure virtual]

virtual bool Torque::FS::File::close (  )  [pure virtual]

virtual U32 Torque::FS::File::read ( void dst,
U32  size 
) [pure virtual]

virtual U32 Torque::FS::File::write ( const void src,
U32  size 
) [pure virtual]