stromx::runtime::ZipFileInput Class Reference

File input which reads the input files from a zip file. More...

#include <ZipFileInput.h>

Inheritance diagram for stromx::runtime::ZipFileInput:

Public Member Functions
	ZipFileInput (const std::string &archive)
virtual void	initialize (const std::string &text, const std::string &filename)
virtual std::istream &	text ()
virtual bool	hasFile () const
virtual std::istream &	openFile (const OpenMode mode)
virtual std::istream &	file ()
virtual void	close ()

Additional Inherited Members
Public Types inherited from stromx::runtime::InputProvider
enum	OpenMode { BINARY, TEXT }

Detailed Description

File input which reads the input files from a zip file.

Constructor & Destructor Documentation

ZipFileInput()

stromx::runtime::ZipFileInput::ZipFileInput ( const std::string &  archive )

explicit

Constructs a zip file input which reads files from a zip file.

Parameters

archive

The path to the zip file.

Exceptions

FileAccessFailed

If the zip file could not be opened.

Member Function Documentation

close()

void stromx::runtime::ZipFileInput::close ( )

virtual

Closes the file input. If this functions is not called the input is closed by the destructor.

Implements stromx::runtime::FileInput.

file()

std::istream & stromx::runtime::ZipFileInput::file ( )

virtual

Returns the input stream with the file representation of the data.

Exceptions

WrongState

If the input provider has not been correctly initialized or if openFile() has not been called before calling this function.

Implements stromx::runtime::InputProvider.

hasFile()

bool stromx::runtime::ZipFileInput::hasFile ( ) const

virtual

Returns true if a file representation of the data exists.

Implements stromx::runtime::InputProvider.

initialize()

void stromx::runtime::ZipFileInput::initialize ( const std::string &  text, const std::string &  filename  )

virtual

Initializes the file input to text and file data.

Parameters

text	The text data.
filename	The name of the file which contains the file data. Pass an empty string if no file should be provided.

Implements stromx::runtime::FileInput.

openFile()

std::istream & stromx::runtime::ZipFileInput::openFile ( const OpenMode  mode )

virtual

Opens the file representation of the data and returns the associated input stream.

Exceptions

NoInputFile	If no file is provided.
WrongState	If the input provider has not been correctly initialized or if this function has already been called.
FileAccessFailed	If the file could not be opened.

Implements stromx::runtime::InputProvider.

text()

std::istream & stromx::runtime::ZipFileInput::text ( )

virtual

Returns an input stream with the text representation of the data.

Exceptions

WrongState

If the input provider has not been correctly initialized.

Implements stromx::runtime::InputProvider.

---

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

• stromx/runtime/ZipFileInput.h
• stromx/runtime/ZipFileInput.cpp