OGRE
1.9.0
|
Common subclass of DataStream for handling data from chunks of memory. More...
#include <OgreDataStream.h>
Public Types | |
enum | AccessMode { READ = 1 , WRITE = 2 } |
Public Member Functions | |
MemoryDataStream (const String &name, const DataStreamPtr &sourceStream, bool freeOnClose=true, bool readOnly=false) | |
Create a named stream which pre-buffers the contents of another stream. | |
MemoryDataStream (const String &name, DataStream &sourceStream, bool freeOnClose=true, bool readOnly=false) | |
Create a named stream which pre-buffers the contents of another stream. | |
MemoryDataStream (const String &name, size_t size, bool freeOnClose=true, bool readOnly=false) | |
Create a named stream with a brand new empty memory chunk. | |
MemoryDataStream (const String &name, void *pMem, size_t size, bool freeOnClose=false, bool readOnly=false) | |
Wrap an existing memory chunk in a named stream. | |
MemoryDataStream (DataStream &sourceStream, bool freeOnClose=true, bool readOnly=false) | |
Create a stream which pre-buffers the contents of another stream. | |
MemoryDataStream (DataStreamPtr &sourceStream, bool freeOnClose=true, bool readOnly=false) | |
Create a stream which pre-buffers the contents of another stream. | |
MemoryDataStream (size_t size, bool freeOnClose=true, bool readOnly=false) | |
Create a stream with a brand new empty memory chunk. | |
MemoryDataStream (void *pMem, size_t size, bool freeOnClose=false, bool readOnly=false) | |
Wrap an existing memory chunk in a stream. | |
~MemoryDataStream () | |
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. | |
uchar * | getCurrentPtr (void) |
Get a pointer to the current position in the memory block this stream holds. | |
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. | |
uchar * | getPtr (void) |
Get a pointer to the start of the memory block this stream holds. | |
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. | |
void | setFreeOnClose (bool free) |
Sets whether or not to free the encapsulated memory on close. | |
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. | |
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 Attributes | |
uint16 | mAccess |
What type of access is allowed (AccessMode) | |
uchar * | mData |
Pointer to the start of the data area. | |
uchar * | mEnd |
Pointer to the end of the memory. | |
bool | mFreeOnClose |
Do we delete the memory on close. | |
String | mName |
The name (e.g. resource name) that can be used to identify the source for this data (optional) | |
uchar * | mPos |
Pointer to the current position in the memory. | |
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 chunks of memory.
Definition at line 317 of file OgreDataStream.h.
|
inherited |
Enumerator | |
---|---|
READ | |
WRITE |
Definition at line 179 of file OgreDataStream.h.
Ogre::MemoryDataStream::MemoryDataStream | ( | void * | pMem, |
size_t | size, | ||
bool | freeOnClose = false , |
||
bool | readOnly = false |
||
) |
Wrap an existing memory chunk in a stream.
pMem | Pointer to the existing memory |
size | The size of the memory chunk in bytes |
freeOnClose | If true, the memory associated will be destroyed when the stream is closed. Note: it's important that if you set this option to true, that you allocated the memory using OGRE_ALLOC_T with a category of MEMCATEGORY_GENERAL to ensure the freeing of memory matches up. |
readOnly | Whether to make the stream on this memory read-only once created |
Ogre::MemoryDataStream::MemoryDataStream | ( | const String & | name, |
void * | pMem, | ||
size_t | size, | ||
bool | freeOnClose = false , |
||
bool | readOnly = false |
||
) |
Wrap an existing memory chunk in a named stream.
name | The name to give the stream |
pMem | Pointer to the existing memory |
size | The size of the memory chunk in bytes |
freeOnClose | If true, the memory associated will be destroyed when the stream is destroyed. Note: it's important that if you set this option to true, that you allocated the memory using OGRE_ALLOC_T with a category of MEMCATEGORY_GENERAL ensure the freeing of memory matches up. |
readOnly | Whether to make the stream on this memory read-only once created |
Ogre::MemoryDataStream::MemoryDataStream | ( | DataStream & | sourceStream, |
bool | freeOnClose = true , |
||
bool | readOnly = false |
||
) |
Create a stream which pre-buffers the contents of another stream.
sourceStream | Another DataStream which will provide the source of data |
freeOnClose | If true, the memory associated will be destroyed when the stream is destroyed. |
readOnly | Whether to make the stream on this memory read-only once created |
Ogre::MemoryDataStream::MemoryDataStream | ( | DataStreamPtr & | sourceStream, |
bool | freeOnClose = true , |
||
bool | readOnly = false |
||
) |
Create a stream which pre-buffers the contents of another stream.
sourceStream | Another DataStream which will provide the source of data |
freeOnClose | If true, the memory associated will be destroyed when the stream is destroyed. |
readOnly | Whether to make the stream on this memory read-only once created |
Ogre::MemoryDataStream::MemoryDataStream | ( | const String & | name, |
DataStream & | sourceStream, | ||
bool | freeOnClose = true , |
||
bool | readOnly = false |
||
) |
Create a named stream which pre-buffers the contents of another stream.
name | The name to give the stream |
sourceStream | Another DataStream which will provide the source of data |
freeOnClose | If true, the memory associated will be destroyed when the stream is destroyed. |
readOnly | Whether to make the stream on this memory read-only once created |
Ogre::MemoryDataStream::MemoryDataStream | ( | const String & | name, |
const DataStreamPtr & | sourceStream, | ||
bool | freeOnClose = true , |
||
bool | readOnly = false |
||
) |
Create a named stream which pre-buffers the contents of another stream.
name | The name to give the stream |
sourceStream | Another DataStream which will provide the source of data |
freeOnClose | If true, the memory associated will be destroyed when the stream is destroyed. |
readOnly | Whether to make the stream on this memory read-only once created |
Ogre::MemoryDataStream::MemoryDataStream | ( | size_t | size, |
bool | freeOnClose = true , |
||
bool | readOnly = false |
||
) |
Create a stream with a brand new empty memory chunk.
size | The size of the memory chunk to create in bytes |
freeOnClose | If true, the memory associated will be destroyed when the stream is destroyed. |
readOnly | Whether to make the stream on this memory read-only once created |
Ogre::MemoryDataStream::MemoryDataStream | ( | const String & | name, |
size_t | size, | ||
bool | freeOnClose = true , |
||
bool | readOnly = false |
||
) |
Create a named stream with a brand new empty memory chunk.
name | The name to give the stream |
size | The size of the memory chunk to create in bytes |
freeOnClose | If true, the memory associated will be destroyed when the stream is destroyed. |
readOnly | Whether to make the stream on this memory read-only once created |
Ogre::MemoryDataStream::~MemoryDataStream | ( | ) |
Close the stream; this makes further operations invalid.
Implements Ogre::DataStream.
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.
Get a pointer to the current position in the memory block this stream holds.
Definition at line 439 of file OgreDataStream.h.
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.
Get a pointer to the start of the memory block this stream holds.
Definition at line 436 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.
Sets whether or not to free the encapsulated memory on close.
Definition at line 478 of file OgreDataStream.h.
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 from Ogre::DataStream.
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 |
Pointer to the start of the data area.
Definition at line 321 of file OgreDataStream.h.
|
protected |
Pointer to the end of the memory.
Definition at line 325 of file OgreDataStream.h.
|
protected |
Do we delete the memory on close.
Definition at line 327 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.
|
protected |
Pointer to the current position in the memory.
Definition at line 323 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.