Ogre::FileStreamDataStream Class Reference
[Resources]

Common subclass of DataStream for handling data from std::basic_istream. More...

#include <OgreDataStream.h>

Inheritance diagram for Ogre::FileStreamDataStream:

Public Types
enum	AccessMode { READ = 1, WRITE = 2 }
Public Member Functions
	FileStreamDataStream (std::ifstream *s, bool freeOnClose=true)
	Construct a read-only stream from an STL stream.
	FileStreamDataStream (std::fstream *s, bool freeOnClose=true)
	Construct a read-write stream from an STL stream.
	FileStreamDataStream (const String &name, std::ifstream *s, bool freeOnClose=true)
	Construct named read-only stream from an STL stream.
	FileStreamDataStream (const String &name, std::fstream *s, bool freeOnClose=true)
	Construct named read-write 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 (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 ()
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")
void	skip (long count)
void	seek (size_t pos)
size_t	tell (void) const
bool	eof (void) const
void	close (void)
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.
virtual size_t	skipLine (const String &delim="\n")
	Skip a single line from the 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 Member Functions
void	determineAccess ()
Protected Attributes
std::istream *	mInStream
	Reference to source stream (read).
std::ifstream *	mFStreamRO
	Reference to source file stream (read-only).
std::fstream *	mFStream
	Reference to source file stream (read-write).
bool	mFreeOnClose
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 std::basic_istream.

Definition at line 488 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::FileStreamDataStream::FileStreamDataStream	(	std::ifstream *	s,
		bool	freeOnClose = `true`
	)

Construct a read-only stream from an STL stream.

Parameters:

	s	Pointer to source stream
	freeOnClose	Whether to delete the underlying stream on destruction of this class

Ogre::FileStreamDataStream::FileStreamDataStream	(	std::fstream *	s,
		bool	freeOnClose = `true`
	)

Construct a read-write stream from an STL stream.

Parameters:

	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.

Parameters:

	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.

Parameters:

	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.

Remarks:: This variant tells the class the size of the stream too, which means this class does not need to seek to the end of the stream to determine the size up-front. This can be beneficial if you have metadata about the contents of the stream already.

Parameters:

	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.

Remarks:: This variant tells the class the size of the stream too, which means this class does not need to seek to the end of the stream to determine the size up-front. This can be beneficial if you have metadata about the contents of the stream already.

Parameters:

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

Member Function Documentation

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

Close the stream; this makes further operations invalid.

Implements Ogre::DataStream.

void Ogre::FileStreamDataStream::determineAccess ( ) [protected]

bool Ogre::FileStreamDataStream::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.

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.

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