CBZip2CompressionFile Class Reference
[Compression]

Search Toolkit Book for CBZip2CompressionFile

#include <bzip2.hpp>

Inheritance diagram for CBZip2CompressionFile:

Inheritance graph
[legend]
Collaboration diagram for CBZip2CompressionFile:

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 179 of file bzip2.hpp.

Public Member Functions

 CBZip2CompressionFile (const string &file_name, EMode mode, ELevel level=eLevel_Default, int verbosity=0, int work_factor=0, int small_decompress=0)
 Constructor.
 CBZip2CompressionFile (ELevel level=eLevel_Default, int verbosity=0, int work_factor=0, int small_decompress=0)
 Conventional constructor.
 ~CBZip2CompressionFile (void)
virtual bool Open (const string &file_name, EMode mode)
virtual long Read (void *buf, size_t len)
virtual long Write (const void *buf, size_t len)
virtual bool Close (void)

Protected Attributes

FILE * m_FileStream
 Underlying file stream.
bool m_EOF
 EOF flag for read mode.

Constructor & Destructor Documentation

CBZip2CompressionFile::CBZip2CompressionFile (  const string &  file_name,
EMode  mode,
ELevel  level = eLevel_Default,
int  verbosity = 0,
int  work_factor = 0,
int  small_decompress = 0
) 
 

Constructor.

For a special parameters description see CBZip2Compression.

Definition at line 286 of file bzip2.cpp.

References CCompressionFile::eMode_Read, NCBI_THROW, and Open().

CBZip2CompressionFile::CBZip2CompressionFile (  ELevel  level = eLevel_Default,
int  verbosity = 0,
int  work_factor = 0,
int  small_decompress = 0
) 
 

Conventional constructor.

For a special parameters description see CBZip2Compression.

Definition at line 302 of file bzip2.cpp.

CBZip2CompressionFile::~CBZip2CompressionFile (  void   ) 
 

Definition at line 311 of file bzip2.cpp.

References Close().

Member Function Documentation

bool CBZip2CompressionFile::Close (  void   )  [virtual]
 

Implements CCompressionFile.

Definition at line 405 of file bzip2.cpp.

References BZ2_bzReadClose(), BZ2_bzWriteClose(), BZ_OK, CCompressionFile::eMode_Read, ERR_COMPRESS, CBZip2Compression::FormatErrorMessage(), CBZip2Compression::GetBZip2ErrorDescription(), m_EOF, CCompressionFile::m_File, m_FileStream, CCompressionFile::m_Mode, and CCompression::SetError().

Referenced by Open(), and ~CBZip2CompressionFile().

bool CBZip2CompressionFile::Open (  const string &  file_name,
EMode  mode
)  [virtual]
 

Definition at line 318 of file bzip2.cpp.

References BZ2_bzReadOpen(), BZ2_bzWriteOpen(), BZ_OK, Close(), CCompressionFile::eMode_Read, CCompression::eMode_Unknown, ERR_COMPRESS, CBZip2Compression::FormatErrorMessage(), CBZip2Compression::GetBZip2ErrorDescription(), CBZip2Compression::GetLevel(), CCompression::m_DecompressMode, m_EOF, CCompressionFile::m_File, m_FileStream, CCompressionFile::m_Mode, CBZip2Compression::m_SmallDecompress, CBZip2Compression::m_Verbosity, CBZip2Compression::m_WorkFactor, and CCompression::SetError().

Referenced by CBZip2CompressionFile(), CBZip2Compression::CompressFile(), and CBZip2Compression::DecompressFile().

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

Implements CCompressionFile.

Definition at line 347 of file bzip2.cpp.

References BZ2_bzRead(), BZ_DATA_ERROR, BZ_DATA_ERROR_MAGIC, BZ_OK, BZ_STREAM_END, CCompression::eMode_Decompress, CCompression::eMode_TransparentRead, CCompression::eMode_Unknown, ERR_COMPRESS, F_ISSET, CBZip2Compression::fAllowTransparentRead, CBZip2Compression::FormatErrorMessage(), CBZip2Compression::GetBZip2ErrorDescription(), LIMIT_SIZE_PARAM, CCompression::m_DecompressMode, m_EOF, CCompressionFile::m_File, m_FileStream, SEEK_SET, and CCompression::SetError().

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

Implements CCompressionFile.

Definition at line 387 of file bzip2.cpp.

References BZ2_bzWrite(), BZ_OK, BZ_STREAM_END, ERR_COMPRESS, CBZip2Compression::FormatErrorMessage(), CBZip2Compression::GetBZip2ErrorDescription(), LIMIT_SIZE_PARAM, CCompressionFile::m_File, and CCompression::SetError().

Member Data Documentation

bool CBZip2CompressionFile::m_EOF [protected]
 

EOF flag for read mode.

Definition at line 223 of file bzip2.hpp.

Referenced by Close(), Open(), and Read().

FILE* CBZip2CompressionFile::m_FileStream [protected]
 

Underlying file stream.

Definition at line 222 of file bzip2.hpp.

Referenced by Close(), Open(), and Read().

The documentation for this class was generated from the following files:
Generated on Sun Sep 7 13:32:43 2008 for NCBI C++ ToolKit by  doxygen 1.4.6
Modified on Sun Sep 07 17:26:46 2008 by modify_doxy.py rev. 117643