Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Private Member Functions | Private Attributes

Bzip2InputStream Class Reference

Implements the BinInputStream class of the xerces-c library in order to read bzip2 compressed XML files. More...

#include <OpenMS/FORMAT/Bzip2InputStream.h>

Inheritance diagram for Bzip2InputStream:
BinInputStream

List of all members.

Public Member Functions

 Bzip2InputStream (const String &file_name)
 Constructor.
 Bzip2InputStream (const char *const file_name)
virtual ~Bzip2InputStream ()
 Destructor.
bool getIsOpen () const
 returns true if file is open
virtual XMLFilePos curPos () const
 returns the current position in the file
virtual XMLSize_t readBytes (XMLByte *const to_fill, const XMLSize_t max_to_read)
 writes bytes into buffer from file
virtual const XMLCh * getContentType () const
 returns 0

Private Member Functions

 Bzip2InputStream ()
 Bzip2InputStream (const Bzip2InputStream &stream)
Bzip2InputStreamoperator= (const Bzip2InputStream &stream)

Private Attributes

Bzip2Ifstreambzip2_
 pointer to an compression stream
XMLSize_t file_current_index_
 current index of the actual file

Detailed Description

Implements the BinInputStream class of the xerces-c library in order to read bzip2 compressed XML files.


Constructor & Destructor Documentation

Bzip2InputStream ( const String file_name  ) 

Constructor.

Bzip2InputStream ( const char *const   file_name  ) 
virtual ~Bzip2InputStream (  )  [virtual]

Destructor.

Bzip2InputStream (  )  [private]
Bzip2InputStream ( const Bzip2InputStream stream  )  [private]

Member Function Documentation

XMLFilePos curPos (  )  const [inline, virtual]

returns the current position in the file

Note:
Implementation of the xerces-c input stream interface

References Bzip2InputStream::file_current_index_.

virtual const XMLCh* getContentType (  )  const [virtual]

returns 0

Note:
Implementation of the xerces-c input stream interface
bool getIsOpen (  )  const [inline]

returns true if file is open

References Bzip2InputStream::bzip2_, and Bzip2Ifstream::isOpen().

Bzip2InputStream& operator= ( const Bzip2InputStream stream  )  [private]
virtual XMLSize_t readBytes ( XMLByte *const   to_fill,
const XMLSize_t  max_to_read 
) [virtual]

writes bytes into buffer from file

Note:
Implementation of the xerces-c input stream interface
Parameters:
to_fill is the buffer which is written to
max_to_read is the size of the buffer
Returns:
returns the number of bytes which were actually read

Member Data Documentation

Bzip2Ifstream* bzip2_ [private]

pointer to an compression stream

Referenced by Bzip2InputStream::getIsOpen().

XMLSize_t file_current_index_ [private]

current index of the actual file

Referenced by Bzip2InputStream::curPos().


OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:53 using doxygen 1.7.1