OGRE  1.12.4
Object-Oriented Graphics Rendering Engine
Ogre::FileStreamDataStream Class Reference

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. More...
 
 FileStreamDataStream (std::fstream *s, bool freeOnClose=true)
 Construct a read-write stream from an STL stream. More...
 
 FileStreamDataStream (const String &name, std::ifstream *s, bool freeOnClose=true)
 Construct named read-only stream from an STL stream. More...
 
 FileStreamDataStream (const String &name, std::fstream *s, bool freeOnClose=true)
 Construct named read-write stream from an STL stream. More...
 
 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. More...
 
 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. More...
 
 ~FileStreamDataStream ()
 
void close (void)
 Close the stream; this makes further operations invalid. More...
 
bool eof (void) const
 Returns true if the stream has reached the end. More...
 
uint16 getAccessMode () const
 Gets the access mode of the stream. More...
 
virtual String getAsString (void)
 Returns a String containing the entire stream. More...
 
virtual String getLine (bool trimAfter=true)
 Returns a String containing the next line of data, optionally trimmed for whitespace. More...
 
const StringgetName (void)
 Returns the name of the stream, if it has one. More...
 
virtual bool isReadable () const
 Reports whether this stream is readable. More...
 
virtual bool isWriteable () const
 Reports whether this stream is writeable. More...
 
template<typename T >
DataStreamoperator>> (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. More...
 
size_t readLine (char *buf, size_t maxCount, const String &delim="\)
 Get a single line from the stream. More...
 
void seek (size_t pos)
 Repositions the read point to a specified byte. More...
 
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. More...
 
void skip (long count)
 Skip a defined number of bytes. More...
 
virtual size_t skipLine (const String &delim="\)
 Skip a single line from the stream. More...
 
size_t tell (void) const
 Returns the current byte offset from beginning. More...
 
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) More...
 

Detailed Description

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

Member Enumeration Documentation

◆ AccessMode

Enumerator
READ 
WRITE 

Constructor & Destructor Documentation

◆ FileStreamDataStream() [1/6]

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

Construct a read-only stream from an STL stream.

Parameters
sPointer to source stream
freeOnCloseWhether to delete the underlying stream on destruction of this class

◆ FileStreamDataStream() [2/6]

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

Construct a read-write stream from an STL stream.

Parameters
sPointer to source stream
freeOnCloseWhether to delete the underlying stream on destruction of this class

◆ FileStreamDataStream() [3/6]

Ogre::FileStreamDataStream::FileStreamDataStream ( const String name,
std::ifstream *  s,
bool  freeOnClose = true 
)

Construct named read-only stream from an STL stream.

Parameters
nameThe name to give this stream
sPointer to source stream
freeOnCloseWhether to delete the underlying stream on destruction of this class

◆ FileStreamDataStream() [4/6]

Ogre::FileStreamDataStream::FileStreamDataStream ( const String name,
std::fstream *  s,
bool  freeOnClose = true 
)

Construct named read-write stream from an STL stream.

Parameters
nameThe name to give this stream
sPointer to source stream
freeOnCloseWhether to delete the underlying stream on destruction of this class

◆ FileStreamDataStream() [5/6]

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
nameThe name to give this stream
sPointer to source stream
sizeSize of the stream contents in bytes
freeOnCloseWhether 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.

◆ FileStreamDataStream() [6/6]

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
nameThe name to give this stream
sPointer to source stream
sizeSize of the stream contents in bytes
freeOnCloseWhether 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.

◆ ~FileStreamDataStream()

Ogre::FileStreamDataStream::~FileStreamDataStream ( )

Member Function Documentation

◆ read()

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
bufReference to a buffer pointer
countNumber of bytes to read
Returns
The number of bytes read

Implements Ogre::DataStream.

◆ write()

size_t Ogre::FileStreamDataStream::write ( const void *  buf,
size_t  count 
)
virtual

Write the requisite number of bytes from the stream (only applicable to streams that are not read-only)

Parameters
bufPointer to a buffer containing the bytes to write
countNumber of bytes to write
Returns
The number of bytes written

Reimplemented from Ogre::DataStream.

◆ readLine()

size_t Ogre::FileStreamDataStream::readLine ( char *  buf,
size_t  maxCount 
)
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.
Note
If you used this function, you must open the stream in binary mode, otherwise, it'll produce unexpected results.
Parameters
bufReference to a buffer pointer
maxCountThe maximum length of data to be read, excluding the terminating character
delimThe delimiter to stop at
Returns
The number of bytes read, excluding the terminating character

Reimplemented from Ogre::DataStream.

◆ skip()

void Ogre::FileStreamDataStream::skip ( long  count)
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.

Implements Ogre::DataStream.

◆ seek()

void Ogre::FileStreamDataStream::seek ( size_t  pos)
virtual

Repositions the read point to a specified byte.

Implements Ogre::DataStream.

◆ tell()

size_t Ogre::FileStreamDataStream::tell ( void  ) const
virtual

Returns the current byte offset from beginning.

Implements Ogre::DataStream.

◆ eof()

bool Ogre::FileStreamDataStream::eof ( void  ) const
virtual

Returns true if the stream has reached the end.

Implements Ogre::DataStream.

◆ close()

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

Close the stream; this makes further operations invalid.

Implements Ogre::DataStream.

◆ getName()

const String& Ogre::DataStream::getName ( void  )
inlineinherited

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

◆ getAccessMode()

uint16 Ogre::DataStream::getAccessMode ( ) const
inlineinherited

Gets the access mode of the stream.

◆ isReadable()

virtual bool Ogre::DataStream::isReadable ( ) const
inlinevirtualinherited

Reports whether this stream is readable.

◆ isWriteable()

virtual bool Ogre::DataStream::isWriteable ( ) const
inlinevirtualinherited

Reports whether this stream is writeable.

◆ operator>>()

template<typename T >
DataStream& Ogre::DataStream::operator>> ( T &  val)
inherited

◆ getLine()

virtual String Ogre::DataStream::getLine ( bool  trimAfter = true)
virtualinherited

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
trimAfterIf true, the line is trimmed for whitespace (as in String.trim(true,true))

◆ getAsString()

virtual String Ogre::DataStream::getAsString ( void  )
virtualinherited

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.

◆ skipLine()

virtual size_t Ogre::DataStream::skipLine ( )
virtualinherited

Skip a single line from the stream.

Note
If you used this function, you must open the stream in binary mode, otherwise, it'll produce unexpected results.
Parameters
delimThe delimiter(s) to stop at
Returns
The number of bytes skipped

Reimplemented in Ogre::MemoryDataStream.

◆ size()

size_t Ogre::DataStream::size ( void  ) const
inlineinherited

Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream.


The documentation for this class was generated from the following file: