SaveFilter Struct Reference

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

#include <saveload_filter.h>

Inheritance diagram for SaveFilter:
FileWriter LZOSaveFilter NoCompSaveFilter PacketWriter ZlibSaveFilter

Public Member Functions

 SaveFilter (SaveFilter *chain)
 Initialise this filter.
virtual ~SaveFilter ()
 Make sure the writers are properly closed.
virtual void Write (byte *buf, size_t len)=0
 Write a given number of bytes into the savegame.
virtual void Finish ()
 Prepare everything to finish writing the savegame.

Data Fields

SaveFilterchain
 Chained to the (savegame) filters.

Detailed Description

Interface for filtering a savegame till it is written.

Definition at line 62 of file saveload_filter.h.


Constructor & Destructor Documentation

SaveFilter::SaveFilter ( SaveFilter chain  )  [inline]

Initialise this filter.

Parameters:
chain The next filter in this chain.

Definition at line 70 of file saveload_filter.h.

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

Make sure the writers are properly closed.

Definition at line 75 of file saveload_filter.h.

References chain.


Member Function Documentation

virtual void SaveFilter::Write ( byte *  buf,
size_t  len 
) [pure virtual]

Write a given number of bytes into the savegame.

Parameters:
buf The bytes to write.
len The number of bytes to write.

Implemented in PacketWriter, FileWriter, LZOSaveFilter, NoCompSaveFilter, and ZlibSaveFilter.

Referenced by MemoryDumper::Flush(), SaveFileToDisk(), NoCompSaveFilter::Write(), LZOSaveFilter::Write(), and ZlibSaveFilter::WriteLoop().


Field Documentation

Chained to the (savegame) filters.

Definition at line 64 of file saveload_filter.h.

Referenced by Finish(), ZlibSaveFilter::Finish(), NoCompSaveFilter::Write(), LZOSaveFilter::Write(), ZlibSaveFilter::WriteLoop(), and ~SaveFilter().


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

Generated on Sun Jan 9 16:03:15 2011 for OpenTTD by  doxygen 1.6.1