Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
RawFileClass Class Reference

#include <RAWFILE.H>

Inherits FileClass, and FileClass.

Inherited by BufferIOFileClass, BufferedFileClass, TagBlockFile [protected], and TextFileClass.

Public Member Functions

 RawFileClass (char const *filename)
 
 RawFileClass (void)
 
 RawFileClass (RawFileClass const &f)
 
RawFileClass & operator= (RawFileClass const &f)
 
virtual ~RawFileClass (void)
 
virtual char const * File_Name (void) const
 
virtual char const * Set_Name (char const *filename)
 
virtual int Create (void)
 
virtual int Delete (void)
 
virtual bool Is_Available (int forced=false)
 
virtual bool Is_Open (void) const
 
virtual int Open (char const *filename, int rights=READ)
 
virtual int Open (int rights=READ)
 
virtual int Read (void *buffer, int size)
 
virtual int Seek (int pos, int dir=SEEK_CUR)
 
virtual int Size (void)
 
virtual int Write (void const *buffer, int size)
 
virtual void Close (void)
 
virtual unsigned long Get_Date_Time (void)
 
virtual bool Set_Date_Time (unsigned long datetime)
 
virtual void Error (int error, int canretry=false, char const *filename=NULL)
 
virtual void Bias (int start, int length=-1)
 
virtual void * Get_File_Handle (void)
 
virtual void Attach (void *handle, int rights=READ)
 
virtual void Detach (void)
 
 RawFileClass (char const *filename)
 
 RawFileClass (void)
 
 RawFileClass (RawFileClass const &f)
 
RawFileClass & operator= (RawFileClass const &f)
 
virtual ~RawFileClass (void)
 
virtual char const * File_Name (void) const
 
virtual char const * Set_Name (char const *filename)
 
virtual int Create (void)
 
virtual int Delete (void)
 
virtual bool Is_Available (int forced=false)
 
virtual bool Is_Open (void) const
 
virtual int Open (char const *filename, int rights=READ)
 
virtual int Open (int rights=READ)
 
virtual int Read (void *buffer, int size)
 
virtual int Seek (int pos, int dir=SEEK_CUR)
 
virtual int Size (void)
 
virtual int Write (void const *buffer, int size)
 
virtual void Close (void)
 
virtual unsigned long Get_Date_Time (void)
 
virtual bool Set_Date_Time (unsigned long datetime)
 
virtual void Error (int error, int canretry=false, char const *filename=NULL)
 
void Bias (int start, int length=-1)
 
virtual void * Get_File_Handle (void)
 
virtual void Attach (void *handle, int rights=READ)
 
virtual void Detach (void)
 
- Public Member Functions inherited from FileClass
virtual ~FileClass (void)
 
virtual int Tell (void)
 
 operator char const * ()
 
int Printf (char *str,...)
 
int Printf (char *buffer, int bufferSize, char *str,...)
 
int Printf_Indented (unsigned depth, char *str,...)
 
virtual ~FileClass (void)
 
virtual int Tell (void)
 
 operator char const * ()
 
int Printf (char *str,...)
 
int Printf (char *buffer, int bufferSize, char *str,...)
 
int Printf_Indented (unsigned depth, char *str,...)
 

Public Attributes

int Rights
 
int BiasStart
 
int BiasLength
 

Protected Member Functions

int Transfer_Block_Size (void)
 
int Raw_Seek (int pos, int dir=SEEK_CUR)
 
void Reset (void)
 
int Transfer_Block_Size (void)
 
int Raw_Seek (int pos, int dir=SEEK_CUR)
 
void Reset (void)
 

Additional Inherited Members

- Public Types inherited from FileClass
enum  { READ = 1 , WRITE = 2 , PRINTF_BUFFER_SIZE = 1024 }
 
enum  { READ = 1 , WRITE = 2 , PRINTF_BUFFER_SIZE = 1024 }
 

Detailed Description

Definition at line 80 of file RAWFILE.H.

Constructor & Destructor Documentation

◆ RawFileClass() [1/6]

RawFileClass::RawFileClass ( char const * filename)

Definition at line 246 of file rawfile.cpp.

◆ RawFileClass() [2/6]

RawFileClass::RawFileClass ( void )

Definition at line 148 of file rawfile.cpp.

◆ RawFileClass() [3/6]

RawFileClass::RawFileClass ( RawFileClass const & f)

◆ ~RawFileClass() [1/2]

RawFileClass::~RawFileClass ( void )
virtual

Definition at line 273 of file rawfile.cpp.

◆ RawFileClass() [4/6]

RawFileClass::RawFileClass ( char const * filename)

◆ RawFileClass() [5/6]

RawFileClass::RawFileClass ( void )

◆ RawFileClass() [6/6]

RawFileClass::RawFileClass ( RawFileClass const & f)

◆ ~RawFileClass() [2/2]

virtual RawFileClass::~RawFileClass ( void )
virtual

Member Function Documentation

◆ Attach() [1/2]

void RawFileClass::Attach ( void * handle,
int rights = READ )
virtual

Definition at line 1227 of file rawfile.cpp.

◆ Attach() [2/2]

virtual void RawFileClass::Attach ( void * handle,
int rights = READ )
virtual

◆ Bias() [1/2]

void RawFileClass::Bias ( int start,
int length = -1 )
virtual

Definition at line 1130 of file rawfile.cpp.

◆ Bias() [2/2]

void RawFileClass::Bias ( int start,
int length = -1 )

◆ Close() [1/2]

void RawFileClass::Close ( void )
virtual

Implements FileClass.

Reimplemented in BufferedFileClass, and BufferIOFileClass.

Definition at line 561 of file rawfile.cpp.

◆ Close() [2/2]

virtual void RawFileClass::Close ( void )
virtual

Implements FileClass.

Reimplemented in BufferedFileClass, and BufferIOFileClass.

◆ Create() [1/2]

int RawFileClass::Create ( void )
virtual

Implements FileClass.

Definition at line 919 of file rawfile.cpp.

◆ Create() [2/2]

virtual int RawFileClass::Create ( void )
virtual

Implements FileClass.

◆ Delete() [1/2]

int RawFileClass::Delete ( void )
virtual

Implements FileClass.

Definition at line 957 of file rawfile.cpp.

◆ Delete() [2/2]

virtual int RawFileClass::Delete ( void )
virtual

Implements FileClass.

◆ Detach() [1/2]

void RawFileClass::Detach ( void )
virtual

Definition at line 1256 of file rawfile.cpp.

◆ Detach() [2/2]

virtual void RawFileClass::Detach ( void )
virtual

◆ Error() [1/2]

void RawFileClass::Error ( int error,
int canretry = false,
char const * filename = NULL )
virtual

Implements FileClass.

Definition at line 204 of file rawfile.cpp.

◆ Error() [2/2]

virtual void RawFileClass::Error ( int error,
int canretry = false,
char const * filename = NULL )
virtual

Implements FileClass.

◆ File_Name() [1/2]

char const * RawFileClass::File_Name ( void ) const
inlinevirtual

Implements FileClass.

Definition at line 186 of file RAWFILE.H.

◆ File_Name() [2/2]

virtual char const * RawFileClass::File_Name ( void ) const
virtual

Implements FileClass.

◆ Get_Date_Time() [1/2]

unsigned long RawFileClass::Get_Date_Time ( void )
virtual

Reimplemented from FileClass.

Reimplemented in TagBlockFile.

Definition at line 1024 of file rawfile.cpp.

◆ Get_Date_Time() [2/2]

virtual unsigned long RawFileClass::Get_Date_Time ( void )
virtual

Reimplemented from FileClass.

Reimplemented in TagBlockFile.

◆ Get_File_Handle() [1/2]

virtual void * RawFileClass::Get_File_Handle ( void )
inlinevirtual

Reimplemented from FileClass.

Definition at line 115 of file RAWFILE.H.

◆ Get_File_Handle() [2/2]

virtual void * RawFileClass::Get_File_Handle ( void )
inlinevirtual

Reimplemented from FileClass.

Definition at line 116 of file rawfile.h.

◆ Is_Available() [1/2]

bool RawFileClass::Is_Available ( int forced = false)
virtual

Implements FileClass.

Reimplemented in BufferIOFileClass.

Definition at line 489 of file rawfile.cpp.

◆ Is_Available() [2/2]

virtual bool RawFileClass::Is_Available ( int forced = false)
virtual

Implements FileClass.

Reimplemented in BufferIOFileClass.

◆ Is_Open() [1/2]

bool RawFileClass::Is_Open ( void ) const
virtual

Implements FileClass.

Reimplemented in BufferIOFileClass.

Definition at line 176 of file rawfile.cpp.

◆ Is_Open() [2/2]

virtual bool RawFileClass::Is_Open ( void ) const
virtual

Implements FileClass.

Reimplemented in BufferIOFileClass.

◆ Open() [1/4]

int RawFileClass::Open ( char const * filename,
int rights = READ )
virtual

Implements FileClass.

Reimplemented in BufferIOFileClass.

Definition at line 356 of file rawfile.cpp.

◆ Open() [2/4]

virtual int RawFileClass::Open ( char const * filename,
int rights = READ )
virtual

Implements FileClass.

Reimplemented in BufferIOFileClass.

◆ Open() [3/4]

int RawFileClass::Open ( int rights = READ)
virtual

Implements FileClass.

Reimplemented in BufferIOFileClass.

Definition at line 381 of file rawfile.cpp.

◆ Open() [4/4]

virtual int RawFileClass::Open ( int rights = READ)
virtual

Implements FileClass.

Reimplemented in BufferIOFileClass.

◆ operator=() [1/2]

RawFileClass & RawFileClass::operator= ( RawFileClass const & f)

◆ operator=() [2/2]

RawFileClass & RawFileClass::operator= ( RawFileClass const & f)

◆ Raw_Seek() [1/2]

int RawFileClass::Raw_Seek ( int pos,
int dir = SEEK_CUR )
protected

Definition at line 1173 of file rawfile.cpp.

◆ Raw_Seek() [2/2]

int RawFileClass::Raw_Seek ( int pos,
int dir = SEEK_CUR )
protected

◆ Read() [1/2]

int RawFileClass::Read ( void * buffer,
int size )
virtual

Implements FileClass.

Reimplemented in BufferedFileClass, and BufferIOFileClass.

Definition at line 614 of file rawfile.cpp.

◆ Read() [2/2]

virtual int RawFileClass::Read ( void * buffer,
int size )
virtual

Implements FileClass.

Reimplemented in BufferedFileClass, and BufferIOFileClass.

◆ Reset() [1/2]

void RawFileClass::Reset ( void )
protected

Definition at line 290 of file rawfile.cpp.

◆ Reset() [2/2]

void RawFileClass::Reset ( void )
protected

◆ Seek() [1/2]

int RawFileClass::Seek ( int pos,
int dir = SEEK_CUR )
virtual

Implements FileClass.

Reimplemented in BufferedFileClass, and BufferIOFileClass.

Definition at line 773 of file rawfile.cpp.

◆ Seek() [2/2]

virtual int RawFileClass::Seek ( int pos,
int dir = SEEK_CUR )
virtual

Implements FileClass.

Reimplemented in BufferedFileClass, and BufferIOFileClass.

◆ Set_Date_Time() [1/2]

bool RawFileClass::Set_Date_Time ( unsigned long datetime)
virtual

Reimplemented from FileClass.

Definition at line 1088 of file rawfile.cpp.

◆ Set_Date_Time() [2/2]

virtual bool RawFileClass::Set_Date_Time ( unsigned long datetime)
virtual

Reimplemented from FileClass.

◆ Set_Name() [1/2]

char const * RawFileClass::Set_Name ( char const * filename)
virtual

Implements FileClass.

Reimplemented in BufferIOFileClass.

Definition at line 313 of file rawfile.cpp.

◆ Set_Name() [2/2]

virtual char const * RawFileClass::Set_Name ( char const * filename)
virtual

Implements FileClass.

Reimplemented in BufferIOFileClass.

◆ Size() [1/2]

int RawFileClass::Size ( void )
virtual

Implements FileClass.

Reimplemented in BufferIOFileClass.

Definition at line 842 of file rawfile.cpp.

◆ Size() [2/2]

virtual int RawFileClass::Size ( void )
virtual

Implements FileClass.

Reimplemented in BufferIOFileClass.

◆ Transfer_Block_Size() [1/2]

int RawFileClass::Transfer_Block_Size ( void )
protected

Definition at line 224 of file rawfile.cpp.

◆ Transfer_Block_Size() [2/2]

int RawFileClass::Transfer_Block_Size ( void )
protected

◆ Write() [1/2]

int RawFileClass::Write ( void const * buffer,
int size )
virtual

Implements FileClass.

Reimplemented in BufferedFileClass, and BufferIOFileClass.

Definition at line 698 of file rawfile.cpp.

◆ Write() [2/2]

virtual int RawFileClass::Write ( void const * buffer,
int size )
virtual

Implements FileClass.

Reimplemented in BufferedFileClass, and BufferIOFileClass.

Member Data Documentation

◆ BiasLength

int RawFileClass::BiasLength

Definition at line 126 of file RAWFILE.H.

◆ BiasStart

int RawFileClass::BiasStart

Definition at line 125 of file RAWFILE.H.

◆ Rights

int RawFileClass::Rights

Definition at line 90 of file RAWFILE.H.

The documentation for this class was generated from the following files: