OGRE
14.3
Object-Oriented Graphics Rendering Engine
|
General purpose class used for encapsulating the reading and writing of data. More...
#include <OgreDataStream.h>
Public Types | |
enum | AccessMode { READ = 1 , WRITE = 2 } |
Public Member Functions | |
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 () |
virtual void | close (void)=0 |
Close the stream; this makes further operations invalid. More... | |
virtual bool | eof (void) const =0 |
Returns true if the stream has reached the end. More... | |
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) |
virtual size_t | read (void *buf, size_t count)=0 |
Read the requisite number of bytes from the stream, stopping at the end of the file. More... | |
virtual size_t | readLine (char *buf, size_t maxCount, const String &delim="\n") |
Get a single line from the stream. More... | |
virtual void | seek (size_t pos)=0 |
Repositions the read point to a specified byte. More... | |
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 void | skip (long count)=0 |
Skip a defined number of bytes. More... | |
virtual size_t | skipLine (const String &delim="\n") |
Skip a single line from the stream. More... | |
virtual size_t | tell (void) const =0 |
Returns the current byte offset from beginning. More... | |
virtual size_t | write (const void *buf, size_t count) |
Write the requisite number of bytes from the stream (only applicable to streams that are not read-only) More... | |
General purpose class used for encapsulating the reading and writing of data.
This class performs basically the same tasks as std::basic_istream, except that it does not have any formatting capabilities, and is designed to be subclassed to receive data from multiple sources, including libraries which have no compatibility with the STL's stream interfaces. As such, this is an abstraction of a set of wrapper classes which pretend to be standard stream classes but can actually be implemented quite differently.
Constructor for creating unnamed streams.
Constructor for creating named streams.
|
inlinevirtual |
|
inline |
Returns the name of the stream, if it has one.
|
inline |
Gets the access mode of the stream.
|
inlinevirtual |
Reports whether this stream is readable.
|
inlinevirtual |
Reports whether this stream is writeable.
DataStream& Ogre::DataStream::operator>> | ( | T & | val | ) |
|
pure 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 |
Implemented in Ogre::DeflateStream, Ogre::FileHandleDataStream, Ogre::FileStreamDataStream, and Ogre::MemoryDataStream.
|
inlinevirtual |
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 in Ogre::DeflateStream, Ogre::FileHandleDataStream, Ogre::FileStreamDataStream, and Ogre::MemoryDataStream.
|
virtual |
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 in Ogre::FileStreamDataStream, and Ogre::MemoryDataStream.
|
virtual |
Returns a String containing the next line of data, optionally trimmed for whitespace.
This is a convenience method for text streams only, allowing you to retrieve a String object containing the next line of data. The data is read up to the next newline character and the result trimmed if required.
trimAfter | If true, the line is trimmed for whitespace (as in String.trim(true,true)) |
|
virtual |
Returns a String containing the entire stream.
This is a convenience method for text streams only, allowing you to retrieve a String object containing all the data in the stream.
|
virtual |
Skip a single line from the stream.
Reimplemented in Ogre::MemoryDataStream.
|
pure 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.
Implemented in Ogre::DeflateStream, Ogre::FileHandleDataStream, Ogre::FileStreamDataStream, and Ogre::MemoryDataStream.
|
pure virtual |
Repositions the read point to a specified byte.
Implemented in Ogre::DeflateStream, Ogre::FileHandleDataStream, Ogre::FileStreamDataStream, and Ogre::MemoryDataStream.
|
pure virtual |
Returns the current byte offset from beginning.
Implemented in Ogre::DeflateStream, Ogre::FileHandleDataStream, Ogre::FileStreamDataStream, and Ogre::MemoryDataStream.
|
pure virtual |
Returns true if the stream has reached the end.
Implemented in Ogre::DeflateStream, Ogre::FileHandleDataStream, Ogre::FileStreamDataStream, and Ogre::MemoryDataStream.
|
inline |
Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream.
|
pure virtual |
Close the stream; this makes further operations invalid.
Implemented in Ogre::DeflateStream, Ogre::FileHandleDataStream, Ogre::FileStreamDataStream, and Ogre::MemoryDataStream.