zipios::ZipInputStream Class Reference

#include <zipinputstream.h>

Inherits std::istream.

List of all members.

Public Member Functions
int	available ()
void	close ()
	Closes the istream.
void	closeEntry ()
	Closes the current entry, and positions the stream read pointer at the beginning of the next entry (if there is one).
ConstEntryPointer	getNextEntry ()
	ZipInputStream (const std::string &filename, std::streampos pos=0)
	ZipInputStream constructor.
	ZipInputStream (std::istream &is, std::streampos pos=0)
	ZipInputStream constructor.
virtual	~ZipInputStream ()
	Destructor.

---

Detailed Description

ZipInputStream is an istream that gets it's input from a zip file. The interface approximates the interface of the Java ZipInputStream.

Definition at line 20 of file zipinputstream.h.

---

Constructor & Destructor Documentation

zipios::ZipInputStream::ZipInputStream	(	std::istream &	is,
		std::streampos	pos = 0
	)			[explicit]

ZipInputStream constructor.

Parameters:

	is	istream from which the compressed zip archive can be read.
	pos	position to reposition the istream to before reading.

Definition at line 13 of file zipinputstream.cpp.

zipios::ZipInputStream::ZipInputStream	(	const std::string &	filename,
		std::streampos	pos = 0
	)			[explicit]

ZipInputStream constructor.

Parameters:

	filename	filename of a valid zip file.
	pos	position to reposition the istream to before reading.

Definition at line 23 of file zipinputstream.cpp.

zipios::ZipInputStream::~ZipInputStream

(

)

[virtual]

Destructor.

Definition at line 53 of file zipinputstream.cpp.

---

Member Function Documentation

int zipios::ZipInputStream::available

(

)

Definition at line 33 of file zipinputstream.cpp.

void zipios::ZipInputStream::close

(

)

Closes the istream.

Definition at line 41 of file zipinputstream.cpp.

References zipios::ZipInputStreambuf::close().

void zipios::ZipInputStream::closeEntry

(

)

Closes the current entry, and positions the stream read pointer at the beginning of the next entry (if there is one).

Definition at line 37 of file zipinputstream.cpp.

References zipios::ZipInputStreambuf::closeEntry().

ConstEntryPointer zipios::ZipInputStream::getNextEntry

(

)

Opens the next entry in the zip archive and returns a const pointer to a FileEntry object for the entry.

Returns:

a const FileEntry * containing information about the (now) current entry.

Definition at line 48 of file zipinputstream.cpp.

References zipios::ZipInputStreambuf::getNextEntry().

Referenced by Base::XMLReader::readFiles().

---

The documentation for this class was generated from the following files:

• zipinputstream.h
• zipinputstream.cpp