#include <OgreDataStream.h>
Public Member Functions | ||||||||||
| FileStreamDataStream (std::ifstream *s, bool freeOnClose=true) | ||||||||||
| Construct stream from an STL stream. | ||||||||||
| FileStreamDataStream (const String &name, std::ifstream *s, bool freeOnClose=true) | ||||||||||
| Construct named stream from an STL stream. | ||||||||||
| FileStreamDataStream (const String &name, std::ifstream *s, size_t size, bool freeOnClose=true) | ||||||||||
| Construct named stream from an STL stream, and tell it the size. | ||||||||||
| ~FileStreamDataStream () | ||||||||||
| size_t | read (void *buf, size_t count) | |||||||||
| Read the requisite number of bytes from the stream, stopping at the end of the file.
| ||||||||||
| size_t | readLine (char *buf, size_t maxCount, const String &delim="\n") | |||||||||
| Get a single line from the stream.
| ||||||||||
| void | skip (long count) | |||||||||
| 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. | ||||||||||
| void | seek (size_t pos) | |||||||||
| Repositions the read point to a specified byte. | ||||||||||
| size_t | tell (void) const | |||||||||
| Returns the current byte offset from beginning. | ||||||||||
| bool | eof (void) const | |||||||||
| Returns true if the stream has reached the end. | ||||||||||
| void | close (void) | |||||||||
| Close the stream; this makes further operations invalid. | ||||||||||
| const String & | getName (void) | |||||||||
| Returns the name of the stream, if it has one. | ||||||||||
| template<typename T> | ||||||||||
| DataStream & | operator>> (T &val) | |||||||||
| virtual String | getLine (bool trimAfter=true) | |||||||||
| Returns a String containing the next line of data, optionally trimmed for whitespace. | ||||||||||
| virtual String | getAsString (void) | |||||||||
| Returns a String containing the entire stream. | ||||||||||
| virtual size_t | skipLine (const String &delim="\n") | |||||||||
| Skip a single line from the stream. | ||||||||||
| 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. | ||||||||||
Protected Attributes | ||||||||||
| std::ifstream * | mpStream | |||||||||
| Reference to source stream. | ||||||||||
| bool | mFreeOnClose | |||||||||
| String | mName | |||||||||
| The name (e.g. resource name) that can be used to identify the source fot his data (optional). | ||||||||||
| size_t | mSize | |||||||||
| Size of the data in the stream (may be 0 if size cannot be determined). | ||||||||||
Definition at line 322 of file OgreDataStream.h.
| Ogre::FileStreamDataStream::FileStreamDataStream | ( | std::ifstream * | s, | |
| bool | freeOnClose = true | |||
| ) |
Construct 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 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 stream from an STL stream, and tell it the size.
| 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 |
| Ogre::FileStreamDataStream::~FileStreamDataStream | ( | ) |
| size_t Ogre::FileStreamDataStream::read | ( | void * | buf, | |
| size_t | count | |||
| ) | [virtual] |
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.
| size_t Ogre::FileStreamDataStream::readLine | ( | char * | buf, | |
| size_t | maxCount, | |||
| const String & | delim = "\n" | |||
| ) | [virtual] |
Get a single line from the stream.
| 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.
| void Ogre::FileStreamDataStream::skip | ( | long | count | ) | [virtual] |
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.
| void Ogre::FileStreamDataStream::seek | ( | size_t | pos | ) | [virtual] |
| size_t Ogre::FileStreamDataStream::tell | ( | void | ) | const [virtual] |
| bool Ogre::FileStreamDataStream::eof | ( | void | ) | const [virtual] |
| void Ogre::FileStreamDataStream::close | ( | void | ) | [virtual] |
| const String& Ogre::DataStream::getName | ( | void | ) | [inherited] |
| DataStream& Ogre::DataStream::operator>> | ( | T & | val | ) | [inherited] |
| virtual String Ogre::DataStream::getLine | ( | bool | trimAfter = true |
) | [virtual, inherited] |
Returns a String containing the next line of data, optionally trimmed for whitespace.
| trimAfter | If true, the line is trimmed for whitespace (as in String.trim(true,true)) |
| virtual String Ogre::DataStream::getAsString | ( | void | ) | [virtual, inherited] |
Returns a String containing the entire stream.
| virtual size_t Ogre::DataStream::skipLine | ( | const String & | delim = "\n" |
) | [virtual, inherited] |
Skip a single line from the stream.
| delim | The delimiter(s) to stop at |
Reimplemented in Ogre::MemoryDataStream.
| size_t Ogre::DataStream::size | ( | void | ) | const [inherited] |
Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream.
Definition at line 149 of file OgreDataStream.h.
std::ifstream* Ogre::FileStreamDataStream::mpStream [protected] |
bool Ogre::FileStreamDataStream::mFreeOnClose [protected] |
Definition at line 327 of file OgreDataStream.h.
String Ogre::DataStream::mName [protected, inherited] |
The name (e.g. resource name) that can be used to identify the source fot his data (optional).
Definition at line 62 of file OgreDataStream.h.
size_t Ogre::DataStream::mSize [protected, inherited] |
Size of the data in the stream (may be 0 if size cannot be determined).
Definition at line 64 of file OgreDataStream.h.
Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Mon Jun 16 12:49:30 2008