OpenTTD
Public Member Functions | Data Fields
SaveFilter Struct Reference

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

#include <saveload_filter.h>

Inheritance diagram for SaveFilter:
FileWriter LZMASaveFilter LZOSaveFilter NoCompSaveFilter PacketWriter ZlibSaveFilter HeaderFileWriter LanguageFileWriter

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
chainThe next filter in this chain.

Definition at line 70 of file saveload_filter.h.

virtual SaveFilter::~SaveFilter ( )
inlinevirtual

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
bufThe bytes to write.
lenThe number of bytes to write.

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

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

Field Documentation

SaveFilter* SaveFilter::chain

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