OGRE-Next  3.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::FileHandleDataStream Class Referencefinal

Common subclass of DataStream for handling data from C-style file handles. More...

#include <OgreDataStream.h>

+ Inheritance diagram for Ogre::FileHandleDataStream:

Public Member Functions

 FileHandleDataStream (const String &name, FILE *handle, uint16 accessMode=READ)
 Create named stream from a C file handle. More...
 
 FileHandleDataStream (FILE *handle, uint16 accessMode=READ)
 Create stream from a C file handle. More...
 
 ~FileHandleDataStream () override
 
void close () override
 Close the stream; this makes further operations invalid. More...
 
bool eof () const override
 Returns true if the stream has reached the end. More...
 
size_t read (void *buf, size_t count) override
 Read the requisite number of bytes from the stream, stopping at the end of the file. More...
 
void seek (size_t pos) override
 Repositions the read point to a specified byte. More...
 
void skip (long count) override
 Skip a defined number of bytes. More...
 
size_t tell () const override
 Returns the current byte offset from beginning. More...
 
size_t write (const void *buf, size_t count) override
 Write the requisite number of bytes from the stream (only applicable to streams that are not read-only) More...
 
- Public Member Functions inherited from Ogre::DataStream
 DataStream (const String &name, uint16 accessMode=READ)
 Constructor for creating named streams. More...
 
 DataStream (uint16 accessMode=READ)
 Constructor for creating unnamed streams. More...
 
virtual ~DataStream ()
 
uint16 getAccessMode () const
 Gets the access mode of the stream. More...
 
virtual String getAsString ()
 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 ()
 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)
 
virtual size_t readLine (char *buf, size_t maxCount, const String &delim="\n")
 Get a single line from the stream. More...
 
size_t size () const
 Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream. More...
 
virtual size_t skipLine (const String &delim="\n")
 Skip a single line from the stream. More...
 

Additional Inherited Members

- Public Types inherited from Ogre::DataStream
enum  AccessMode { READ = 1 , WRITE = 2 }
 

Detailed Description

Common subclass of DataStream for handling data from C-style file handles.

Remarks
Use of this class is generally discouraged; if you want to wrap file access in a DataStream, you should definitely be using the C++ friendly FileStreamDataStream. However, since there are quite a few applications and libraries still wedded to the old FILE handle access, this stream wrapper provides some backwards compatibility.

Constructor & Destructor Documentation

◆ FileHandleDataStream() [1/2]

Ogre::FileHandleDataStream::FileHandleDataStream ( FILE *  handle,
uint16  accessMode = READ 
)

Create stream from a C file handle.

◆ FileHandleDataStream() [2/2]

Ogre::FileHandleDataStream::FileHandleDataStream ( const String name,
FILE *  handle,
uint16  accessMode = READ 
)

Create named stream from a C file handle.

◆ ~FileHandleDataStream()

Ogre::FileHandleDataStream::~FileHandleDataStream ( )
override

Member Function Documentation

◆ close()

void Ogre::FileHandleDataStream::close ( )
overridevirtual

Close the stream; this makes further operations invalid.

Implements Ogre::DataStream.

◆ eof()

bool Ogre::FileHandleDataStream::eof ( ) const
overridevirtual

Returns true if the stream has reached the end.

Implements Ogre::DataStream.

◆ read()

size_t Ogre::FileHandleDataStream::read ( void *  buf,
size_t  count 
)
overridevirtual

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.

◆ seek()

void Ogre::FileHandleDataStream::seek ( size_t  pos)
overridevirtual

Repositions the read point to a specified byte.

Implements Ogre::DataStream.

◆ skip()

void Ogre::FileHandleDataStream::skip ( long  count)
overridevirtual

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.

◆ tell()

size_t Ogre::FileHandleDataStream::tell ( ) const
overridevirtual

Returns the current byte offset from beginning.

Implements Ogre::DataStream.

◆ write()

size_t Ogre::FileHandleDataStream::write ( const void *  buf,
size_t  count 
)
overridevirtual

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.


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