OGRE
14.3
Object-Oriented Graphics Rendering Engine
|
Common subclass of DataStream for handling data from std::basic_istream. More...
#include <OgreDataStream.h>
Public Member Functions | |
FileStreamDataStream (const String &name, std::fstream *s, bool freeOnClose=true) | |
Construct named read-write stream from an STL stream. More... | |
FileStreamDataStream (const String &name, std::fstream *s, size_t size, bool freeOnClose=true) | |
Construct named read-write stream from an STL stream, and tell it the size. More... | |
FileStreamDataStream (const String &name, std::ifstream *s, bool freeOnClose=true) | |
Construct named read-only stream from an STL stream. More... | |
FileStreamDataStream (const String &name, std::ifstream *s, size_t size, bool freeOnClose=true) | |
Construct named read-only stream from an STL stream, and tell it the size. More... | |
FileStreamDataStream (std::fstream *s, bool freeOnClose=true) | |
Construct a read-write stream from an STL stream. More... | |
FileStreamDataStream (std::ifstream *s, bool freeOnClose=true) | |
Construct a read-only stream from an STL stream. More... | |
~FileStreamDataStream () | |
void | close (void) override |
Close the stream; this makes further operations invalid. More... | |
bool | eof (void) const override |
Returns true if the stream has reached the end. More... | |
size_t | read (void *buf, size_t count) override |
Read the requisite number of bytes from the stream, stopping at the end of the file. More... | |
size_t | readLine (char *buf, size_t maxCount, const String &delim="\n") override |
Get a single line from the stream. More... | |
void | seek (size_t pos) override |
Repositions the read point to a specified byte. More... | |
void | skip (long count) override |
Skip a defined number of bytes. More... | |
size_t | tell (void) const override |
Returns the current byte offset from beginning. More... | |
size_t | write (const void *buf, size_t count) override |
Write the requisite number of bytes from the stream (only applicable to streams that are not read-only) More... | |
Public Member Functions inherited from Ogre::DataStream | |
DataStream (const String &name, uint16 accessMode=READ) | |
Constructor for creating named streams. More... | |
DataStream (uint16 accessMode=READ) | |
Constructor for creating unnamed streams. More... | |
virtual | ~DataStream () |
uint16 | getAccessMode () const |
Gets the access mode of the stream. More... | |
virtual String | getAsString (void) |
Returns a String containing the entire stream. More... | |
virtual String | getLine (bool trimAfter=true) |
Returns a String containing the next line of data, optionally trimmed for whitespace. More... | |
const String & | getName (void) |
Returns the name of the stream, if it has one. More... | |
virtual bool | isReadable () const |
Reports whether this stream is readable. More... | |
virtual bool | isWriteable () const |
Reports whether this stream is writeable. More... | |
template<typename T > | |
DataStream & | operator>> (T &val) |
size_t | size (void) const |
Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream. More... | |
virtual size_t | skipLine (const String &delim="\n") |
Skip a single line from the stream. More... | |
Additional Inherited Members | |
Public Types inherited from Ogre::DataStream | |
enum | AccessMode { READ = 1 , WRITE = 2 } |
Common subclass of DataStream for handling data from std::basic_istream.
Ogre::FileStreamDataStream::FileStreamDataStream | ( | std::ifstream * | s, |
bool | freeOnClose = true |
||
) |
Construct a read-only stream from an STL stream.
s | Pointer to source stream |
freeOnClose | Whether to delete the underlying stream on destruction of this class |
Ogre::FileStreamDataStream::FileStreamDataStream | ( | std::fstream * | s, |
bool | freeOnClose = true |
||
) |
Construct a read-write stream from an STL stream.
s | Pointer to source stream |
freeOnClose | Whether to delete the underlying stream on destruction of this class |
Ogre::FileStreamDataStream::FileStreamDataStream | ( | const String & | name, |
std::ifstream * | s, | ||
bool | freeOnClose = true |
||
) |
Construct named read-only stream from an STL stream.
name | The name to give this stream |
s | Pointer to source stream |
freeOnClose | Whether to delete the underlying stream on destruction of this class |
Ogre::FileStreamDataStream::FileStreamDataStream | ( | const String & | name, |
std::fstream * | s, | ||
bool | freeOnClose = true |
||
) |
Construct named read-write stream from an STL stream.
name | The name to give this stream |
s | Pointer to source stream |
freeOnClose | Whether to delete the underlying stream on destruction of this class |
Ogre::FileStreamDataStream::FileStreamDataStream | ( | const String & | name, |
std::ifstream * | s, | ||
size_t | size, | ||
bool | freeOnClose = true |
||
) |
Construct named read-only stream from an STL stream, and tell it the size.
This variant tells the class the size of the stream too, which means this class does not need to seek to the end of the stream to determine the size up-front. This can be beneficial if you have metadata about the contents of the stream already.
name | The name to give this stream |
s | Pointer to source stream |
size | Size of the stream contents in bytes |
freeOnClose | Whether to delete the underlying stream on destruction of this class. If you specify 'true' for this you must ensure that the stream was allocated using OGRE_NEW_T with MEMCATEGRORY_GENERAL. |
Ogre::FileStreamDataStream::FileStreamDataStream | ( | const String & | name, |
std::fstream * | s, | ||
size_t | size, | ||
bool | freeOnClose = true |
||
) |
Construct named read-write stream from an STL stream, and tell it the size.
This variant tells the class the size of the stream too, which means this class does not need to seek to the end of the stream to determine the size up-front. This can be beneficial if you have metadata about the contents of the stream already.
name | The name to give this stream |
s | Pointer to source stream |
size | Size of the stream contents in bytes |
freeOnClose | Whether to delete the underlying stream on destruction of this class. If you specify 'true' for this you must ensure that the stream was allocated using OGRE_NEW_T with MEMCATEGRORY_GENERAL. |
Ogre::FileStreamDataStream::~FileStreamDataStream | ( | ) |
|
overridevirtual |
Read the requisite number of bytes from the stream, stopping at the end of the file.
buf | Reference to a buffer pointer |
count | Number of bytes to read |
Implements Ogre::DataStream.
|
overridevirtual |
Write the requisite number of bytes from the stream (only applicable to streams that are not read-only)
buf | Pointer to a buffer containing the bytes to write |
count | Number of bytes to write |
Reimplemented from Ogre::DataStream.
|
overridevirtual |
Get a single line from the stream.
The delimiter character is not included in the data returned, and it is skipped over so the next read will occur after it. The buffer contents will include a terminating character.
buf | Reference to a buffer pointer |
maxCount | The maximum length of data to be read, excluding the terminating character |
delim | The delimiter to stop at |
Reimplemented from Ogre::DataStream.
|
overridevirtual |
Skip a defined number of bytes.
This can also be a negative value, in which case the file pointer rewinds a defined number of bytes.
Implements Ogre::DataStream.
|
overridevirtual |
Repositions the read point to a specified byte.
Implements Ogre::DataStream.
|
overridevirtual |
Returns the current byte offset from beginning.
Implements Ogre::DataStream.
|
overridevirtual |
Returns true if the stream has reached the end.
Implements Ogre::DataStream.
|
overridevirtual |
Close the stream; this makes further operations invalid.
Implements Ogre::DataStream.