stromx  0.8.0
Public Member Functions | List of all members
stromx::runtime::FileInput Class Referenceabstract

Provides functions to initialize an input provider. More...

#include <FileInput.h>

Inheritance diagram for stromx::runtime::FileInput:
stromx::runtime::InputProvider stromx::runtime::DirectoryFileInput stromx::runtime::ZipFileInput

Public Member Functions

virtual void initialize (const std::string &text, const std::string &filename="")=0
 
virtual void close ()=0
 
- Public Member Functions inherited from stromx::runtime::InputProvider
virtual std::istream & text ()=0
 
virtual bool hasFile () const =0
 
virtual std::istream & openFile (const OpenMode mode=BINARY)=0
 
virtual std::istream & file ()=0
 

Additional Inherited Members

- Public Types inherited from stromx::runtime::InputProvider
enum  OpenMode { BINARY, TEXT }
 

Detailed Description

Provides functions to initialize an input provider.

Member Function Documentation

§ close()

virtual void stromx::runtime::FileInput::close ( )
pure virtual

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

Implemented in stromx::runtime::ZipFileInput, and stromx::runtime::DirectoryFileInput.

§ initialize()

virtual void stromx::runtime::FileInput::initialize ( const std::string &  text,
const std::string &  filename = "" 
)
pure virtual

Initializes the file input to text and file data.

Parameters
textThe text data.
filenameThe name of the file which contains the file data. Pass an empty string if no file should be provided.

Implemented in stromx::runtime::ZipFileInput, and stromx::runtime::DirectoryFileInput.


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