ZipInputStream Class Reference

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

#include <OpenMS/FORMAT/ZipInputStream.h>

Inheritance diagram for ZipInputStream:

Collaboration diagram for ZipInputStream:

Public Member Functions
	ZipInputStream (const String &file_name)
	Constructor.
	ZipInputStream (const char *const file_name)
	~ZipInputStream () override
	Destructor.
bool	getIsOpen () const
	returns true if file is open
XMLFilePos	curPos () const override
	returns the current position in the file
XMLSize_t	readBytes (XMLByte *const to_fill, const XMLSize_t max_to_read) override
	writes bytes into buffer from file
const XMLCh *	getContentType () const override
	returns 0
	ZipInputStream ()=delete
	ZipInputStream (const ZipInputStream &stream)=delete
ZipInputStream &	operator= (const ZipInputStream &stream)=delete

Private Attributes
ZipIfstream *	zip_ = nullptr
	pointer to the zip decompression 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 ZIP compressed XML files.

Constructor & Destructor Documentation

ZipInputStream() [1/4]

ZipInputStream ( const String &  file_name )

explicit

Constructor.

ZipInputStream() [2/4]

ZipInputStream ( const char *const  file_name )

explicit

~ZipInputStream()

~ZipInputStream ( )

override

Destructor.

ZipInputStream() [3/4]

ZipInputStream ( )

delete

ZipInputStream() [4/4]

ZipInputStream ( const ZipInputStream &  stream )

delete

Member Function Documentation

curPos()

XMLFilePos curPos ( ) const

inlineoverride

returns the current position in the file

Note

Implementation of the xerces-c input stream interface

References ZipInputStream::file_current_index_.

getContentType()

const XMLCh * getContentType ( ) const

override

returns 0

Note

Implementation of the xerces-c input stream interface

getIsOpen()

bool getIsOpen

(

)

const

returns true if file is open

operator=()

ZipInputStream & operator= ( const ZipInputStream &  stream )

delete

readBytes()

XMLSize_t readBytes ( XMLByte *const  to_fill, const XMLSize_t  max_to_read  )

override

writes bytes into buffer from file

Note

Implementation of the xerces-c input stream interface

Parameters

[out]	to_fill	is the buffer which is written to
[in]	max_to_read	is the size of the buffer

Returns

returns the number of bytes which were actually read

Member Data Documentation

file_current_index_

XMLSize_t file_current_index_

private

current index of the actual file

Referenced by ZipInputStream::curPos().

zip_

ZipIfstream* zip_ = nullptr

private

pointer to the zip decompression stream