CCompressionFile Class Reference
[Compression]

Search Toolkit Book for CCompressionFile

#include <compress.hpp>

Inheritance diagram for CCompressionFile:

[legend]Collaboration diagram for CCompressionFile:

[legend]List of all members.

---

Detailed Description

Definition at line 233 of file compress.hpp.

Public Types
typedef void *	TFile
	Compression file handler.
enum	EMode { eMode_Read, eMode_Write }
	File open mode. More...
Public Member Functions
	CCompressionFile (void)
	CCompressionFile (const string &path, EMode mode)
virtual	~CCompressionFile (void)
virtual bool	Open (const string &path, EMode mode)=0
virtual long	Read (void *buf, size_t len)=0
virtual long	Write (const void *buf, size_t len)=0
virtual bool	Close (void)=0
Protected Attributes
TFile	m_File
	File handler.
EMode	m_Mode
	File open mode.

---

Member Typedef Documentation

typedef void* CCompressionFile::TFile

Compression file handler. Definition at line 237 of file compress.hpp.

---

Member Enumeration Documentation

enum CCompressionFile::EMode

File open mode. Enumerator: eMode_Read  Reading from compressed file. eMode_Write  Writing compressed data to file. Definition at line 240 of file compress.hpp.

---

Constructor & Destructor Documentation

CCompressionFile::CCompressionFile (  void   )

Definition at line 191 of file compress.cpp.

CCompressionFile::CCompressionFile (  const string &  path, EMode  mode )

CCompressionFile::~CCompressionFile (  void   )  [virtual]

Definition at line 198 of file compress.cpp.

---

Member Function Documentation

virtual bool CCompressionFile::Close (  void   )  [pure virtual]

Implemented in CBZip2CompressionFile, and CZipCompressionFile.

virtual bool CCompressionFile::Open (  const string &  path, EMode  mode )  [pure virtual]

virtual long CCompressionFile::Read (  void *  buf, size_t  len )  [pure virtual]

Implemented in CBZip2CompressionFile, and CZipCompressionFile.

virtual long CCompressionFile::Write (  const void *  buf, size_t  len )  [pure virtual]

Implemented in CBZip2CompressionFile, and CZipCompressionFile.

---

Member Data Documentation

TFile CCompressionFile::m_File [protected]

File handler. Reimplemented in CZipCompressionFile. Definition at line 268 of file compress.hpp. Referenced by CBZip2CompressionFile::Close(), CBZip2CompressionFile::Open(), CBZip2CompressionFile::Read(), and CBZip2CompressionFile::Write().

EMode CCompressionFile::m_Mode [protected]

File open mode. Reimplemented in CZipCompressionFile. Definition at line 269 of file compress.hpp. Referenced by CBZip2CompressionFile::Close(), and CBZip2CompressionFile::Open().

---

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

• include/util/compress/compress.hpp
• src/util/compress/compress.cpp

---