Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
BufferedFileClass Class Reference

#include <bufffile.h>

Inherits RawFileClass.

Public Member Functions

 BufferedFileClass (char const *filename)
 
 BufferedFileClass (void)
 
 BufferedFileClass (RawFileClass const &f)
 
BufferedFileClassoperator= (BufferedFileClass const &f)
 
virtual ~BufferedFileClass (void)
 
virtual int Read (void *buffer, int size)
 
virtual int Seek (int pos, int dir=SEEK_CUR)
 
virtual int Write (void const *buffer, int size)
 
virtual void Close (void)
 
- Public Member Functions inherited from RawFileClass
 RawFileClass (char const *filename)
 
 RawFileClass (void)
 
 RawFileClass (RawFileClass const &f)
 
RawFileClassoperator= (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 Size (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)
 
RawFileClassoperator= (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 Size (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,...)
 

Protected Member Functions

void Reset_Buffer (void)
 
- Protected Member Functions inherited from RawFileClass
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)
 

Static Protected Member Functions

static void Set_Desired_Buffer_Size (int size)
 

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 }
 
- Public Attributes inherited from RawFileClass
int Rights
 
int BiasStart
 
int BiasLength
 

Detailed Description

Definition at line 54 of file bufffile.h.

Constructor & Destructor Documentation

◆ BufferedFileClass() [1/3]

BufferedFileClass::BufferedFileClass ( char const * filename)

Definition at line 59 of file bufffile.cpp.

◆ BufferedFileClass() [2/3]

BufferedFileClass::BufferedFileClass ( void )

Definition at line 47 of file bufffile.cpp.

◆ BufferedFileClass() [3/3]

BufferedFileClass::BufferedFileClass ( RawFileClass const & f)

◆ ~BufferedFileClass()

BufferedFileClass::~BufferedFileClass ( void )
virtual

Definition at line 71 of file bufffile.cpp.

Member Function Documentation

◆ Close()

void BufferedFileClass::Close ( void )
virtual

Reimplemented from RawFileClass.

Definition at line 79 of file bufffile.cpp.

◆ operator=()

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

◆ Read()

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

Reimplemented from RawFileClass.

Definition at line 109 of file bufffile.cpp.

◆ Reset_Buffer()

void BufferedFileClass::Reset_Buffer ( void )
protected

Definition at line 243 of file bufffile.cpp.

◆ Seek()

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

Reimplemented from RawFileClass.

Definition at line 220 of file bufffile.cpp.

◆ Set_Desired_Buffer_Size()

static void BufferedFileClass::Set_Desired_Buffer_Size ( int size)
inlinestaticprotected

Definition at line 73 of file bufffile.h.

◆ Write()

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

Reimplemented from RawFileClass.

Definition at line 189 of file bufffile.cpp.


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