Common subclass of DataStream for handling data from std::basic_istream. More...
#include <OgreDataStream.h>
Public Types | |
enum | AccessMode { READ = 1 , WRITE = 2 } |
Public Member Functions | |
FileStreamDataStream (const String &name, std::fstream *s, bool freeOnClose=true) | |
Construct named read-write stream from an STL stream. | |
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. | |
FileStreamDataStream (const String &name, std::ifstream *s, bool freeOnClose=true) | |
Construct named read-only stream from an STL stream. | |
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. | |
FileStreamDataStream (std::fstream *s, bool freeOnClose=true) | |
Construct a read-write stream from an STL stream. | |
FileStreamDataStream (std::ifstream *s, bool freeOnClose=true) | |
Construct a read-only stream from an STL stream. | |
~FileStreamDataStream () | |
void | close (void) |
Close the stream; this makes further operations invalid. | |
bool | eof (void) const |
Returns true if the stream has reached the end. | |
uint16 | getAccessMode () const |
Gets the access mode of the stream. | |
virtual String | getAsString (void) |
Returns a String containing the entire stream. | |
virtual String | getLine (bool trimAfter=true) |
Returns a String containing the next line of data, optionally trimmed for whitespace. | |
const String & | getName (void) |
Returns the name of the stream, if it has one. | |
virtual bool | isReadable () const |
Reports whether this stream is readable. | |
virtual bool | isWriteable () const |
Reports whether this stream is writeable. | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info | |
void * | operator new (size_t sz, void *ptr) |
placement operator new | |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info | |
template<typename T > | |
DataStream & | operator>> (T &val) |
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 | seek (size_t pos) |
Repositions the read point to a specified byte. | |
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. | |
void | skip (long count) |
Skip a defined number of bytes. | |
virtual size_t | skipLine (const String &delim="\n") |
Skip a single line from the stream. | |
size_t | tell (void) const |
Returns the current byte offset from beginning. | |
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) | |
Protected Member Functions | |
void | determineAccess () |
Protected Attributes | |
uint16 | mAccess |
What type of access is allowed (AccessMode) | |
bool | mFreeOnClose |
std::fstream * | mFStream |
Reference to source file stream (read-write) | |
std::ifstream * | mFStreamRO |
Reference to source file stream (read-only) | |
std::istream * | mInStream |
Reference to source stream (read) | |
String | mName |
The name (e.g. resource name) that can be used to identify the source for this data (optional) | |
size_t | mSize |
Size of the data in the stream (may be 0 if size cannot be determined) | |
Common subclass of DataStream for handling data from std::basic_istream.
Definition at line 489 of file OgreDataStream.h.
|
inherited |
Enumerator | |
---|---|
READ | |
WRITE |
Definition at line 179 of file OgreDataStream.h.
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 |
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.
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.
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 | ( | ) |
Close the stream; this makes further operations invalid.
Implements Ogre::DataStream.
|
protected |
Returns true if the stream has reached the end.
Implements Ogre::DataStream.
|
inherited |
Gets the access mode of the stream.
Definition at line 202 of file OgreDataStream.h.
Returns a String containing the entire stream.
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)) |
Returns the name of the stream, if it has one.
Definition at line 200 of file OgreDataStream.h.
Reports whether this stream is readable.
Definition at line 204 of file OgreDataStream.h.
Reports whether this stream is writeable.
Definition at line 206 of file OgreDataStream.h.
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inherited |
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.
|
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.
Repositions the read point to a specified byte.
Implements Ogre::DataStream.
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 297 of file OgreDataStream.h.
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.
Skip a single line from the stream.
delim | The delimiter(s) to stop at |
Reimplemented in Ogre::MemoryDataStream.
Returns the current byte offset from beginning.
Implements Ogre::DataStream.
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.
|
protectedinherited |
What type of access is allowed (AccessMode)
Definition at line 190 of file OgreDataStream.h.
|
protected |
Definition at line 498 of file OgreDataStream.h.
|
protected |
Reference to source file stream (read-write)
Definition at line 497 of file OgreDataStream.h.
|
protected |
Reference to source file stream (read-only)
Definition at line 495 of file OgreDataStream.h.
|
protected |
Reference to source stream (read)
Definition at line 493 of file OgreDataStream.h.
|
protectedinherited |
The name (e.g. resource name) that can be used to identify the source for this data (optional)
Definition at line 186 of file OgreDataStream.h.
|
protectedinherited |
Size of the data in the stream (may be 0 if size cannot be determined)
Definition at line 188 of file OgreDataStream.h.
Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.