Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
GzipInputStream Class Reference

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

#include <OpenMS/FORMAT/GzipInputStream.h>

Inheritance diagram for GzipInputStream:

Public Member Functions

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

Private Member Functions

 GzipInputStream ()
 
 GzipInputStream (const GzipInputStream &stream)
 
GzipInputStreamoperator= (const GzipInputStream &stream)
 

Private Attributes

GzipIfstreamgzip_
 pointer to an compression stream More...
 
XMLSize_t file_current_index_
 current index of the actual file More...
 

Detailed Description

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

Constructor & Destructor Documentation

GzipInputStream ( const String file_name)
explicit

Constructor.

GzipInputStream ( const char *const  file_name)
explicit
virtual ~GzipInputStream ( )
virtual

Destructor.

GzipInputStream ( )
private
GzipInputStream ( const GzipInputStream stream)
private

Member Function Documentation

XMLFilePos curPos ( ) const
inlinevirtual

returns the current position in the file

Note
Implementation of the xerces-c input stream interface

References GzipInputStream::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 GzipInputStream::gzip_, and GzipIfstream::isOpen().

GzipInputStream& operator= ( const GzipInputStream 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_fillis the buffer which is written to
max_to_readis the size of the buffer
Returns
returns the number of bytes which were actually read

Member Data Documentation

XMLSize_t file_current_index_
private

current index of the actual file

Referenced by GzipInputStream::curPos().

GzipIfstream* gzip_
private

pointer to an compression stream

Referenced by GzipInputStream::getIsOpen().


OpenMS / TOPP release 2.0.0 Documentation generated on Thu Aug 20 2015 01:44:35 using doxygen 1.8.9.1