OGRE
1.9.0
|
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. | |
DataStream (uint16 accessMode=READ) | |
Constructor for creating unnamed streams. | |
virtual | ~DataStream () |
virtual void | close (void)=0 |
Close the stream; this makes further operations invalid. | |
virtual bool | eof (void) const =0 |
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) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz) |
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, 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 *ptr) |
placement operator new | |
void * | operator new[] (size_t sz) |
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 | |
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) |
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. | |
virtual size_t | readLine (char *buf, size_t maxCount, const String &delim="\n") |
Get a single line from the stream. | |
virtual void | seek (size_t pos)=0 |
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. | |
virtual void | skip (long count)=0 |
Skip a defined number of bytes. | |
virtual size_t | skipLine (const String &delim="\n") |
Skip a single line from the stream. | |
virtual size_t | tell (void) const =0 |
Returns the current byte offset from beginning. | |
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) | |
Protected Attributes | |
uint16 | mAccess |
What type of access is allowed (AccessMode) | |
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) | |
General purpose class used for encapsulating the reading and writing of data.
Definition at line 176 of file OgreDataStream.h.
Enumerator | |
---|---|
READ | |
WRITE |
Definition at line 179 of file OgreDataStream.h.
Constructor for creating unnamed streams.
Definition at line 195 of file OgreDataStream.h.
References mAccess, mSize, and READ.
Referenced by Ogre::MemoryDataStream::MemoryDataStream(), Ogre::MemoryDataStream::MemoryDataStream(), and operator>>().
|
virtual |
Definition at line 207 of file OgreDataStream.h.
|
pure virtual |
Close the stream; this makes further operations invalid.
Implemented in Ogre::DeflateStream, Ogre::FileHandleDataStream, Ogre::FileStreamDataStream, Ogre::MemoryDataStream, and Ogre::ZipDataStream.
|
pure virtual |
Returns true if the stream has reached the end.
Implemented in Ogre::DeflateStream, Ogre::FileHandleDataStream, Ogre::FileStreamDataStream, Ogre::MemoryDataStream, and Ogre::ZipDataStream.
uint16 Ogre::DataStream::getAccessMode | ( | ) | const |
Gets the access mode of the stream.
Definition at line 202 of file OgreDataStream.h.
References mAccess.
|
virtual |
|
virtual |
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)) |
const String & Ogre::DataStream::getName | ( | void | ) |
Returns the name of the stream, if it has one.
Definition at line 200 of file OgreDataStream.h.
References mName.
|
virtual |
Reports whether this stream is readable.
Definition at line 204 of file OgreDataStream.h.
|
virtual |
Reports whether this stream is writeable.
Definition at line 206 of file OgreDataStream.h.
|
inherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inherited |
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 |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
DataStream & Ogre::DataStream::operator>> | ( | T & | val | ) |
References DataStream().
|
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, Ogre::MemoryDataStream, and Ogre::ZipDataStream.
|
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 in Ogre::FileStreamDataStream, and Ogre::MemoryDataStream.
|
pure virtual |
Repositions the read point to a specified byte.
Implemented in Ogre::DeflateStream, Ogre::FileHandleDataStream, Ogre::FileStreamDataStream, Ogre::MemoryDataStream, and Ogre::ZipDataStream.
size_t Ogre::DataStream::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.
Definition at line 297 of file OgreDataStream.h.
References mSize.
Referenced by Ogre::FileStreamDataStream::FileStreamDataStream(), Ogre::FileStreamDataStream::FileStreamDataStream(), Ogre::MemoryDataStream::MemoryDataStream(), Ogre::MemoryDataStream::MemoryDataStream(), Ogre::MemoryDataStream::MemoryDataStream(), and Ogre::MemoryDataStream::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, Ogre::MemoryDataStream, and Ogre::ZipDataStream.
|
virtual |
Skip a single line from the stream.
delim | The delimiter(s) to stop at |
Reimplemented in Ogre::MemoryDataStream.
|
pure virtual |
Returns the current byte offset from beginning.
Implemented in Ogre::DeflateStream, Ogre::FileHandleDataStream, Ogre::FileStreamDataStream, Ogre::MemoryDataStream, and Ogre::ZipDataStream.
|
virtual |
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.
Definition at line 223 of file OgreDataStream.h.
|
protected |
What type of access is allowed (AccessMode)
Definition at line 190 of file OgreDataStream.h.
Referenced by DataStream(), DataStream(), getAccessMode(), isReadable(), and isWriteable().
|
protected |
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.
Referenced by DataStream(), and getName().
|
protected |
Size of the data in the stream (may be 0 if size cannot be determined)
Definition at line 188 of file OgreDataStream.h.
Referenced by DataStream(), DataStream(), and size().