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

#include <MapReaderWriterInfo.h>

Inherits ChunkInputStream.

Public Member Functions

 CachedFileInputStream (void)
 
 ~CachedFileInputStream (void)
 
Bool open (AsciiString path)
 Returns true if open succeeded.
 
void close (void)
 Explict close. Destructor closes if file is left open.
 
virtual Int read (void *pData, Int numBytes)
 
virtual UnsignedInt tell (void)
 
virtual Bool absoluteSeek (UnsignedInt pos)
 
virtual Bool eof (void)
 
void rewind (void)
 

Protected Attributes

int m_size
 
char * m_buffer
 
int m_pos
 

Detailed Description

An instance of InputStream that uses a FILE* to read data.

Definition at line 85 of file MapReaderWriterInfo.h.

Constructor & Destructor Documentation

◆ CachedFileInputStream()

CachedFileInputStream::CachedFileInputStream ( void )

Definition at line 41 of file DataChunk.cpp.

◆ ~CachedFileInputStream()

CachedFileInputStream::~CachedFileInputStream ( void )

Definition at line 45 of file DataChunk.cpp.

Member Function Documentation

◆ absoluteSeek()

Bool CachedFileInputStream::absoluteSeek ( UnsignedInt pos)
virtual

Implements ChunkInputStream.

Definition at line 135 of file DataChunk.cpp.

◆ close()

void CachedFileInputStream::close ( void )

Explict close. Destructor closes if file is left open.

Definition at line 105 of file DataChunk.cpp.

◆ eof()

Bool CachedFileInputStream::eof ( void )
virtual

Implements ChunkInputStream.

Definition at line 145 of file DataChunk.cpp.

◆ open()

Bool CachedFileInputStream::open ( AsciiString path)

Returns true if open succeeded.

Definition at line 53 of file DataChunk.cpp.

◆ read()

Int CachedFileInputStream::read ( void * pData,
Int numBytes )
virtual

Implements ChunkInputStream.

Definition at line 115 of file DataChunk.cpp.

◆ rewind()

void CachedFileInputStream::rewind ( void )

Definition at line 150 of file DataChunk.cpp.

◆ tell()

UnsignedInt CachedFileInputStream::tell ( void )
virtual

Implements ChunkInputStream.

Definition at line 130 of file DataChunk.cpp.

Member Data Documentation

◆ m_buffer

char* CachedFileInputStream::m_buffer
protected

Definition at line 89 of file MapReaderWriterInfo.h.

◆ m_pos

int CachedFileInputStream::m_pos
protected

Definition at line 90 of file MapReaderWriterInfo.h.

◆ m_size

int CachedFileInputStream::m_size
protected

Definition at line 88 of file MapReaderWriterInfo.h.


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