CCompressionIOStream Class Reference
[CompressionStreams]

Search Toolkit Book for CCompressionIOStream

#include <stream.hpp>

Inheritance diagram for CCompressionIOStream:

Inheritance graph
[legend]
Collaboration diagram for CCompressionIOStream:

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 292 of file stream.hpp.

Public Member Functions

 CCompressionIOStream (CNcbiIos &stream, CCompressionStreamProcessor *read_sp, CCompressionStreamProcessor *write_sp, TOwnership ownership=0)
CCompressionProcessor::EStatus GetStatus (CCompressionStream::EDirection dir)
 Get status of last compression/decompression stream operation.
bool GetError (CCompressionStream::EDirection dir, int &status, string &description)
 Get error code and description of last compressor/decompressor stream operation.
unsigned long GetProcessedSize (CCompressionStream::EDirection dir)
 Return number of processed bytes.
unsigned long GetOutputSize (CCompressionStream::EDirection dir)
 Return number of output bytes.
 DECLARE_OPERATOR_BOOL ((void *) this!=0)
 Test if no stream operation has failed.

Constructor & Destructor Documentation

CCompressionIOStream::CCompressionIOStream (  CNcbiIos &  stream,
CCompressionStreamProcessor *  read_sp,
CCompressionStreamProcessor *  write_sp,
TOwnership  ownership = 0
)  [inline]
 

Definition at line 296 of file stream.hpp.

Member Function Documentation

CCompressionIOStream::DECLARE_OPERATOR_BOOL (  (void *) this!  = 0  ) 
 

Test if no stream operation has failed.

bool CCompressionIOStream::GetError (  CCompressionStream::EDirection  dir,
int &  status,
string &  description
)  [inline]
 

Get error code and description of last compressor/decompressor stream operation.

Return TRUE if information obtained successfully.

Definition at line 311 of file stream.hpp.

References CCompressionStream::x_GetError().

Referenced by CZipCompressionFile::GetStreamError().

unsigned long CCompressionIOStream::GetOutputSize (  CCompressionStream::EDirection  dir  )  [inline]
 

Return number of output bytes.

Definition at line 320 of file stream.hpp.

References CCompressionStream::x_GetOutputSize().

unsigned long CCompressionIOStream::GetProcessedSize (  CCompressionStream::EDirection  dir  )  [inline]
 

Return number of processed bytes.

Definition at line 316 of file stream.hpp.

References CCompressionStream::x_GetProcessedSize().

CCompressionProcessor::EStatus CCompressionIOStream::GetStatus (  CCompressionStream::EDirection  dir  )  [inline]
 

Get status of last compression/decompression stream operation.

Definition at line 306 of file stream.hpp.

References CCompressionStream::x_GetStatus().

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