FIFE::RawDataFile Class Reference

A RawDataSource for a file on the host system. More...

#include <rawdatafile.h>

Inheritance diagram for FIFE::RawDataFile:

Collaboration diagram for FIFE::RawDataFile:

Public Member Functions
	RawDataFile (const std::string &file)
	Constructor Constructs a RawDataSource for file. More...
virtual	~RawDataFile ()
virtual uint32_t	getSize () const
	get the complete datasize More...
virtual void	readInto (uint8_t *buffer, uint32_t start, uint32_t length)
	read data from the source More...
Public Member Functions inherited from FIFE::RawDataSource
	RawDataSource ()
virtual	~RawDataSource ()

Private Attributes
std::string	m_file
std::ifstream	m_stream
uint32_t	m_filesize

Detailed Description

A RawDataSource for a file on the host system.

See also

VFSHostSystem

RawDataSource

Definition at line 43 of file rawdatafile.h.

Constructor & Destructor Documentation

RawDataFile()

FIFE::RawDataFile::RawDataFile

(

const std::string &

file

)

Constructor Constructs a RawDataSource for file.

Parameters

file	The path to the file to load.

Exceptions

CannotOpenFile

Definition at line 36 of file rawdatafile.cpp.

References m_file, m_filesize, and m_stream.

~RawDataFile()

FIFE::RawDataFile::~RawDataFile ( )

virtual

Definition at line 46 of file rawdatafile.cpp.

Member Function Documentation

getSize()

uint32_t FIFE::RawDataFile::getSize ( ) const

virtual

get the complete datasize

Implements FIFE::RawDataSource.

Definition at line 50 of file rawdatafile.cpp.

References m_filesize.

readInto()

void FIFE::RawDataFile::readInto ( uint8_t *  buffer, uint32_t  start, uint32_t  length  )

virtual

read data from the source

Parameters

buffer	the data will be written into buffer
start	the startindex inside the source
length	length bytes will be written into buffer

Implements FIFE::RawDataSource.

Definition at line 54 of file rawdatafile.cpp.

References m_stream.

Member Data Documentation

m_file

std::string FIFE::RawDataFile::m_file

private

Definition at line 58 of file rawdatafile.h.

Referenced by RawDataFile().

m_filesize

uint32_t FIFE::RawDataFile::m_filesize

private

Definition at line 61 of file rawdatafile.h.

Referenced by getSize(), and RawDataFile().

m_stream

std::ifstream FIFE::RawDataFile::m_stream

private

Definition at line 59 of file rawdatafile.h.

Referenced by RawDataFile(), and readInto().

---

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

• engine/core/vfs/raw/rawdatafile.h
• engine/core/vfs/raw/rawdatafile.cpp