CBZip2Compressor Class Reference
[Compression]

Search Toolkit Book for CBZip2Compressor

#include <bzip2.hpp>

Inheritance diagram for CBZip2Compressor:

Inheritance graph
[legend]
Collaboration diagram for CBZip2Compressor:

Collaboration graph
[legend]
List of all members.

Detailed Description

CBZip2Compressor -- bzip2 based compressor.

Used in CBZip2StreamCompressor.

See also:
CBZip2StreamCompressor, CBZip2Compression, CCompressionProcessor

Definition at line 330 of file bzip2.hpp.

Public Member Functions

 CBZip2Compressor (ELevel level=eLevel_Default, int verbosity=0, int work_factor=0, TBZip2Flags flags=0)
 Constructor.
virtual ~CBZip2Compressor (void)
 Destructor.

Protected Member Functions

virtual EStatus Init (void)
virtual EStatus Process (const char *in_buf, size_t in_len, char *out_buf, size_t out_size, size_t *in_avail, size_t *out_avail)
virtual EStatus Flush (char *out_buf, size_t out_size, size_t *out_avail)
virtual EStatus Finish (char *out_buf, size_t out_size, size_t *out_avail)
virtual EStatus End (void)

Constructor & Destructor Documentation

CBZip2Compressor::CBZip2Compressor (  ELevel  level = eLevel_Default,
int  verbosity = 0,
int  work_factor = 0,
TBZip2Flags  flags = 0
) 
 

Constructor.

Definition at line 446 of file bzip2.cpp.

References CCompression::SetFlags().

CBZip2Compressor::~CBZip2Compressor (  void   )  [virtual]
 

Destructor.

Definition at line 454 of file bzip2.cpp.

References End(), and CCompressionProcessor::IsBusy().

Member Function Documentation

CCompressionProcessor::EStatus CBZip2Compressor::End (  void   )  [protected, virtual]
 

Implements CCompressionProcessor.

Definition at line 586 of file bzip2.cpp.

References BZ2_bzCompressEnd(), BZ_OK, ERR_COMPRESS, CCompressionProcessor::eStatus_Error, CCompressionProcessor::eStatus_Success, CBZip2Compression::FormatErrorMessage(), CBZip2Compression::GetBZip2ErrorDescription(), CCompressionProcessor::SetBusy(), CCompression::SetError(), and STREAM.

Referenced by Init(), and ~CBZip2Compressor().

CCompressionProcessor::EStatus CBZip2Compressor::Finish (  char *  out_buf,
size_t  out_size,
size_t *  out_avail
)  [protected, virtual]
 

Implements CCompressionProcessor.

Definition at line 555 of file bzip2.cpp.

References BZ2_bzCompress(), BZ_FINISH, BZ_FINISH_OK, BZ_STREAM_END, ERR_COMPRESS, CCompressionProcessor::eStatus_EndOfData, CCompressionProcessor::eStatus_Error, CCompressionProcessor::eStatus_Overflow, CBZip2Compression::FormatErrorMessage(), CBZip2Compression::GetBZip2ErrorDescription(), CCompressionProcessor::IncreaseOutputSize(), LIMIT_SIZE_PARAM_U, CCompression::SetError(), and STREAM.

CCompressionProcessor::EStatus CBZip2Compressor::Flush (  char *  out_buf,
size_t  out_size,
size_t *  out_avail
)  [protected, virtual]
 

Implements CCompressionProcessor.

Definition at line 524 of file bzip2.cpp.

References BZ2_bzCompress(), BZ_FLUSH, BZ_FLUSH_OK, BZ_RUN_OK, ERR_COMPRESS, CCompressionProcessor::eStatus_Error, CCompressionProcessor::eStatus_Overflow, CCompressionProcessor::eStatus_Success, CBZip2Compression::FormatErrorMessage(), CBZip2Compression::GetBZip2ErrorDescription(), CCompressionProcessor::IncreaseOutputSize(), LIMIT_SIZE_PARAM_U, CCompression::SetError(), and STREAM.

CCompressionProcessor::EStatus CBZip2Compressor::Init (  void   )  [protected, virtual]
 

Implements CCompressionProcessor.

Definition at line 463 of file bzip2.cpp.

References BZ2_bzCompressInit(), BZ_OK, End(), ERR_COMPRESS, CCompressionProcessor::eStatus_Error, CCompressionProcessor::eStatus_Success, CBZip2Compression::FormatErrorMessage(), CBZip2Compression::GetBZip2ErrorDescription(), CBZip2Compression::GetLevel(), CCompressionProcessor::IsBusy(), CBZip2Compression::m_Verbosity, CBZip2Compression::m_WorkFactor, CCompressionProcessor::Reset(), CCompressionProcessor::SetBusy(), CCompression::SetError(), and STREAM.

CCompressionProcessor::EStatus CBZip2Compressor::Process (  const char *  in_buf,
size_t  in_len,
char *  out_buf,
size_t  out_size,
size_t *  in_avail,
size_t *  out_avail
)  [protected, virtual]
 

Implements CCompressionProcessor.

Definition at line 487 of file bzip2.cpp.

References BZ2_bzCompress(), BZ_PARAM_ERROR, BZ_RUN, BZ_RUN_OK, ERR_COMPRESS, CCompressionProcessor::eStatus_Error, CCompressionProcessor::eStatus_Overflow, CCompressionProcessor::eStatus_Success, CBZip2Compression::FormatErrorMessage(), CBZip2Compression::GetBZip2ErrorDescription(), CCompressionProcessor::IncreaseOutputSize(), CCompressionProcessor::IncreaseProcessedSize(), kMax_UInt, LIMIT_SIZE_PARAM_U, CCompression::SetError(), and STREAM.

The documentation for this class was generated from the following files:
Generated on Mon Dec 7 10:34:35 2009 for NCBI C++ ToolKit by  doxygen 1.4.6
Modified on Mon Dec 07 16:22:46 2009 by modify_doxy.py rev. 173732