LoadFilter Struct Reference

Interface for filtering a savegame till it is loaded. More...

#include <saveload_filter.h>

Inheritance diagram for LoadFilter:
FileReader LZOLoadFilter NoCompLoadFilter PacketReader ZlibLoadFilter

Public Member Functions

 LoadFilter (LoadFilter *chain)
 Initialise this filter.
virtual ~LoadFilter ()
 Make sure the writers are properly closed.
virtual size_t Read (byte *buf, size_t len)=0
 Read a given number of bytes from the savegame.
virtual void Reset ()
 Reset this filter to read from the beginning of the file.

Data Fields

LoadFilterchain
 Chained to the (savegame) filters.

Detailed Description

Interface for filtering a savegame till it is loaded.

Definition at line 16 of file saveload_filter.h.


Constructor & Destructor Documentation

LoadFilter::LoadFilter ( LoadFilter chain  )  [inline]

Initialise this filter.

Parameters:
chain The next filter in this chain.

Definition at line 24 of file saveload_filter.h.

virtual LoadFilter::~LoadFilter (  )  [inline, virtual]

Make sure the writers are properly closed.

Definition at line 29 of file saveload_filter.h.

References chain.


Member Function Documentation

virtual size_t LoadFilter::Read ( byte *  buf,
size_t  len 
) [pure virtual]

Read a given number of bytes from the savegame.

Parameters:
buf The bytes to read.
len The number of bytes to read.
Returns:
The number of actually read bytes.

Implemented in PacketReader, FileReader, LZOLoadFilter, NoCompLoadFilter, and ZlibLoadFilter.

Referenced by DoLoad(), ZlibLoadFilter::Read(), NoCompLoadFilter::Read(), and LZOLoadFilter::Read().


Field Documentation

Chained to the (savegame) filters.

Definition at line 18 of file saveload_filter.h.

Referenced by ZlibLoadFilter::Read(), NoCompLoadFilter::Read(), LZOLoadFilter::Read(), Reset(), and ~LoadFilter().


The documentation for this struct was generated from the following file:

Generated on Fri Mar 18 23:18:40 2011 for OpenTTD by  doxygen 1.6.1