GzipIfstream Class Reference

Decompresses files which are compressed in the gzip format (*.gzip). More...

#include <OpenMS/FORMAT/GzipIfstream.h>

List of all members.

Public Member Functions
	GzipIfstream ()
	Default Constructor.
	GzipIfstream (const char *filename)
	Detailed constructor with filename.
virtual	~GzipIfstream ()
	Destructor.
size_t	read (char *s, size_t n)
	reads n bytes from the gzip compressed file into buffer s
bool	streamEnd () const
	indicates whether the read function can be used safely
bool	isOpen () const
	returns whether a file is open.
void	open (const char *filename)
	opens a file for reading (decompression)
void	close ()
	closes current file.
Protected Member Functions
	GzipIfstream (const GzipIfstream &bzip2)
	not implemented
GzipIfstream &	operator= (const GzipIfstream &bzip2)
Protected Attributes
gzFile	gzfile_
	a gzFile object(void*) . Necessary for decompression
int	n_buffer_
	counts the last read bufffer
int	gzerror_
	saves the last returned error by the read function
bool	stream_at_end_
	true if end of file is reached

---

Detailed Description

Decompresses files which are compressed in the gzip format (*.gzip).

---

Constructor & Destructor Documentation

GzipIfstream

(

)

Default Constructor.

GzipIfstream

(

const char *

filename

)

Detailed constructor with filename.

virtual ~GzipIfstream

(

)

[virtual]

Destructor.

GzipIfstream

(

const GzipIfstream &

bzip2

)

[protected]

not implemented

---

Member Function Documentation

void close

(

)

closes current file.

bool isOpen

(

)

const [inline]

returns whether a file is open.

References GzipIfstream::gzfile_.

Referenced by GzipInputStream::getIsOpen().

void open

(

const char *

filename

)

opens a file for reading (decompression)

Note:

any previous open files will be closed first!

GzipIfstream& operator=

(

const GzipIfstream &

bzip2

)

[protected]

size_t read	(	char *	s,
		size_t	n
	)

reads n bytes from the gzip compressed file into buffer s

Parameters:

	s	will be filled with bytes
	n	is the size of the buffer s

Returns:

the number of actually read bytes. If it is 0 the end of the file was reached and the stream is closed

Exceptions:

	Exception::ConversionError	is thrown if decompression fails
	Exception::IllegalArgument	is thrwon if no file for decompression is given. This can happen even happen if a file was already open but read until the end.

bool streamEnd

(

)

const [inline]

indicates whether the read function can be used safely

Returns:

true if end of file was reached. Otherwise false.

References GzipIfstream::stream_at_end_.

---

Member Data Documentation

int gzerror_ [protected]

saves the last returned error by the read function

gzFile gzfile_ [protected]

a gzFile object(void*) . Necessary for decompression

Referenced by GzipIfstream::isOpen().

int n_buffer_ [protected]

counts the last read bufffer

bool stream_at_end_ [protected]

true if end of file is reached

Referenced by GzipIfstream::streamEnd().