MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
Mezzanine::ResourceInputStream Class Reference

A stream from a file, can read from zip files as well. More...

#include <inputstream.h>

+ Inheritance diagram for Mezzanine::ResourceInputStream:
+ Collaboration diagram for Mezzanine::ResourceInputStream:

Public Member Functions

 ResourceInputStream (std::streambuf *InputBuffer, ResourceManager *ResourceManager_)
 Descriptive Constructor. More...
 
virtual ~ResourceInputStream ()
 Tears down the Stream, and Delete the Buffer Passed in.
 
template<class T >
ResourceInputStreamoperator>> (T &Data)
 
bool Readable ()
 Can this be read from. More...
 
bool Writeable ()
 Can this be written to. More...
 

Detailed Description

A stream from a file, can read from zip files as well.

Warning
This currently only supports reading from the stream, and does not support any pointer navigation, or any other non-reading functions

Definition at line 60 of file inputstream.h.

Constructor & Destructor Documentation

Mezzanine::ResourceInputStream::ResourceInputStream ( std::streambuf *  InputBuffer,
ResourceManager ResourceManager_ 
)
inline

Descriptive Constructor.

Parameters
InputBufferA pointer to an Internal::OgreDataStreamBuf. A buffer to read from the disk access subsystem (which happens to be part of Ogre). This Stream will assume ownership of this buffer and will handle deleting it.
ResourceManager_Currently unused, future functionality may tuse this.
Warning
Do not delete the InputBuffer you pass in, this class will assume owner ship and delete it on it's own

Definition at line 79 of file inputstream.h.

Member Function Documentation

bool Mezzanine::ResourceInputStream::Readable ( )

Can this be read from.

Returns
A bool true if it can be read from

Definition at line 76 of file inputstream.cpp.

bool Mezzanine::ResourceInputStream::Writeable ( )

Can this be written to.

Returns
A bool true if it can be written to

Definition at line 81 of file inputstream.cpp.


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