Ogre::MemoryDataStream Class Reference
[Resources]

Common subclass of DataStream for handling data from chunks of memory. More...

#include <OgreDataStream.h>

Inheritance diagram for Ogre::MemoryDataStream:

Public Types
enum	AccessMode { READ = 1, WRITE = 2 }
Public Member Functions
	MemoryDataStream (void *pMem, size_t size, bool freeOnClose=false, bool readOnly=false)
	Wrap an existing memory chunk in a stream.
	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 (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, const DataStreamPtr &sourceStream, bool freeOnClose=true, bool readOnly=false)
	Create a named 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 (const String &name, size_t size, bool freeOnClose=true, bool readOnly=false)
	Create a named stream with a brand new empty memory chunk.
	~MemoryDataStream ()
uchar *	getPtr (void)
	Get a pointer to the start of the memory block this stream holds.
uchar *	getCurrentPtr (void)
	Get a pointer to the current position in the memory block this stream holds.
size_t	read (void *buf, size_t count)
size_t	write (const void *buf, size_t count)
size_t	readLine (char *buf, size_t maxCount, const String &delim="\n")
size_t	skipLine (const String &delim="\n")
void	skip (long count)
void	seek (size_t pos)
size_t	tell (void) const
bool	eof (void) const
void	close (void)
void	setFreeOnClose (bool free)
	Sets whether or not to free the encapsulated memory on close.
const String &	getName (void)
	Returns the name of the stream, if it has one.
uint16	getAccessMode () const
	Gets the access mode of the stream.
virtual bool	isReadable () const
	Reports whether this stream is readable.
virtual bool	isWriteable () const
	Reports whether this stream is writeable.
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.
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 *	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 *	operator new (size_t sz, void *ptr)
	placement operator new
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)
void	operator delete (void *ptr)
void	operator delete (void ptr, void )
void	operator delete (void ptr, const char , int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void ptr, const char , int, const char *)
Protected Attributes
uchar *	mData
	Pointer to the start of the data area.
uchar *	mPos
	Pointer to the current position in the memory.
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 fot his data (optional).
size_t	mSize
	Size of the data in the stream (may be 0 if size cannot be determined).
uint16	mAccess
	What type of access is allowed (AccessMode).

Detailed Description

Common subclass of DataStream for handling data from chunks of memory.

Definition at line 316 of file OgreDataStream.h.

Member Enumeration Documentation

enum Ogre::DataStream::AccessMode [inherited]

Enumerator:

READ
WRITE

Definition at line 178 of file OgreDataStream.h.

Constructor & Destructor Documentation

Ogre::MemoryDataStream::MemoryDataStream	(	void *	pMem,
		size_t	size,
		bool	freeOnClose = `false`,
		bool	readOnly = `false`
	)

Wrap an existing memory chunk in a stream.

Parameters:

	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	(	const String &	name,
		void *	pMem,
		size_t	size,
		bool	freeOnClose = `false`,
		bool	readOnly = `false`
	)

Wrap an existing memory chunk in a named stream.

Parameters:

	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.

Remarks:: This constructor can be used to intentionally read in the entire contents of another stream, copying them to the internal buffer and thus making them available in memory as a single unit.

Parameters:

	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.

Remarks:: This constructor can be used to intentionally read in the entire contents of another stream, copying them to the internal buffer and thus making them available in memory as a single unit.

Parameters:

	sourceStream	Weak reference to 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.

Remarks:: This constructor can be used to intentionally read in the entire contents of another stream, copying them to the internal buffer and thus making them available in memory as a single unit.

Parameters:

	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.

Remarks:: This constructor can be used to intentionally read in the entire contents of another stream, copying them to the internal buffer and thus making them available in memory as a single unit.

Parameters:

	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.

Parameters:

	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.

Parameters:

	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 ( )

Member Function Documentation

void Ogre::MemoryDataStream::close ( void ) [virtual]

Close the stream; this makes further operations invalid.

Implements Ogre::DataStream.

bool Ogre::MemoryDataStream::eof ( void ) const [virtual]

Returns true if the stream has reached the end.

Implements Ogre::DataStream.

uint16 Ogre::DataStream::getAccessMode ( ) const [inherited]

Gets the access mode of the stream.

Definition at line 201 of file OgreDataStream.h.

virtual String Ogre::DataStream::getAsString ( void ) [virtual, inherited]

Returns a String containing the entire stream.

Remarks:: This is a convenience method for text streams only, allowing you to retrieve a String object containing all the data in the stream.

uchar* Ogre::MemoryDataStream::getCurrentPtr ( void )

Get a pointer to the current position in the memory block this stream holds.

Definition at line 438 of file OgreDataStream.h.

virtual String Ogre::DataStream::getLine ( bool trimAfter = true ) [virtual, inherited]

Returns a String containing the next line of data, optionally trimmed for whitespace.

Remarks:: 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.

Note:: If you used this function, you must open the stream in binary mode, otherwise, it'll produce unexpected results.

Parameters:

trimAfter

If true, the line is trimmed for whitespace (as in String.trim(true,true))

const String& Ogre::DataStream::getName ( void ) [inherited]

Returns the name of the stream, if it has one.

Definition at line 199 of file OgreDataStream.h.

uchar* Ogre::MemoryDataStream::getPtr ( void )

Get a pointer to the start of the memory block this stream holds.

Definition at line 435 of file OgreDataStream.h.

virtual bool Ogre::DataStream::isReadable ( ) const [virtual, inherited]

Reports whether this stream is readable.

Definition at line 203 of file OgreDataStream.h.

virtual bool Ogre::DataStream::isWriteable ( ) const [virtual, inherited]

Reports whether this stream is writeable.

Definition at line 205 of file OgreDataStream.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)			`[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr ) [inherited]

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr ) [inherited]

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)			`[inherited]`

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz ) [inherited]

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)			`[inherited]`

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz ) [inherited]

Definition at line 90 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)			`[inherited]`

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

template<typename T >

DataStream& Ogre::DataStream::operator>> ( T & val ) [inherited]

size_t Ogre::MemoryDataStream::read	(	void *	buf,
		size_t	count
	)			`[virtual]`

Read the requisite number of bytes from the stream, stopping at the end of the file.

Parameters:

	buf	Reference to a buffer pointer
	count	Number of bytes to read

Returns:: The number of bytes read

Implements Ogre::DataStream.

size_t Ogre::MemoryDataStream::readLine	(	char *	buf,
		size_t	maxCount,
		const String &	delim = `"\n"`
	)			`[virtual]`

Get a single line from the stream.

Remarks:: 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.