DataChunkInput Class Reference

#include <DataChunk.h>

Public Member Functions
	DataChunkInput (ChunkInputStream *pStream)
	~DataChunkInput ()
void	registerParser (const AsciiString &label, const AsciiString &parentLabel, DataChunkParserPtr parser, void *userData=NULL)
Bool	parse (void *userData=NULL)
Bool	isValidFileType (void)
	Returns TRUE if it is our file format.
AsciiString	openDataChunk (DataChunkVersionType *ver)
void	closeDataChunk (void)
Bool	atEndOfFile (void)
Bool	atEndOfChunk (void)
void	reset (void)
AsciiString	getChunkLabel (void)
DataChunkVersionType	getChunkVersion (void)
unsigned int	getChunkDataSize (void)
unsigned int	getChunkDataSizeLeft (void)
Real	readReal (void)
Int	readInt (void)
Byte	readByte (void)
AsciiString	readAsciiString (void)
UnicodeString	readUnicodeString (void)
Dict	readDict (void)
void	readArrayOfBytes (char *ptr, Int len)
NameKeyType	readNameKey (void)

Public Attributes
void *	m_currentObject
void *	m_userData

Protected Member Functions
void	clearChunkStack (void)
void	decrementDataLeft (int size)

Protected Attributes
ChunkInputStream *	m_file
DataChunkTableOfContents	m_contents
Int	m_fileposOfFirstChunk
UserParser *	m_parserList
InputChunk *	m_chunkStack

Detailed Description

Definition at line 174 of file DataChunk.h.

Constructor & Destructor Documentation

DataChunkInput()

DataChunkInput::DataChunkInput

(

ChunkInputStream *

pStream

)

Definition at line 584 of file DataChunk.cpp.

~DataChunkInput()

DataChunkInput::~DataChunkInput

(

)

Definition at line 597 of file DataChunk.cpp.

Member Function Documentation

atEndOfChunk()

Bool DataChunkInput::atEndOfChunk

(

void

)

Definition at line 832 of file DataChunk.cpp.

atEndOfFile()

Bool DataChunkInput::atEndOfFile ( void )

inline

Definition at line 213 of file DataChunk.h.

clearChunkStack()

void DataChunkInput::clearChunkStack ( void )

protected

Definition at line 695 of file DataChunk.cpp.

closeDataChunk()

void DataChunkInput::closeDataChunk

(

void

)

Definition at line 756 of file DataChunk.cpp.

decrementDataLeft()

void DataChunkInput::decrementDataLeft ( int size )

protected

Definition at line 847 of file DataChunk.cpp.

getChunkDataSize()

UnsignedInt DataChunkInput::getChunkDataSize

(

void

)

Definition at line 806 of file DataChunk.cpp.

getChunkDataSizeLeft()

UnsignedInt DataChunkInput::getChunkDataSizeLeft

(

void

)

Definition at line 820 of file DataChunk.cpp.

getChunkLabel()

AsciiString DataChunkInput::getChunkLabel

(

void

)

Definition at line 780 of file DataChunk.cpp.

getChunkVersion()

DataChunkVersionType DataChunkInput::getChunkVersion

(

void

)

Definition at line 793 of file DataChunk.cpp.

isValidFileType()

Bool DataChunkInput::isValidFileType

(

void

)

Returns TRUE if it is our file format.

Definition at line 716 of file DataChunk.cpp.

openDataChunk()

AsciiString DataChunkInput::openDataChunk

(

DataChunkVersionType *

ver

)

Definition at line 721 of file DataChunk.cpp.

parse()

Bool DataChunkInput::parse

(

void *

userData = NULL

)

Definition at line 628 of file DataChunk.cpp.

readArrayOfBytes()

void DataChunkInput::readArrayOfBytes	(	char *	ptr,
		Int	len )

Definition at line 886 of file DataChunk.cpp.

readAsciiString()

AsciiString DataChunkInput::readAsciiString

(

void

)

Definition at line 952 of file DataChunk.cpp.

readByte()

Byte DataChunkInput::readByte

(

void

)

Definition at line 877 of file DataChunk.cpp.

readDict()

Dict DataChunkInput::readDict

(

void

)

Definition at line 907 of file DataChunk.cpp.

readInt()

Int DataChunkInput::readInt

(

void

)

Definition at line 868 of file DataChunk.cpp.

readNameKey()

NameKeyType DataChunkInput::readNameKey

(

void

)

Definition at line 893 of file DataChunk.cpp.

readReal()

Real DataChunkInput::readReal

(

void

)

Definition at line 859 of file DataChunk.cpp.

readUnicodeString()

UnicodeString DataChunkInput::readUnicodeString

(

void

)

Definition at line 971 of file DataChunk.cpp.

registerParser()

void DataChunkInput::registerParser	(	const AsciiString &	label,
		const AsciiString &	parentLabel,
		DataChunkParserPtr	parser,
		void *	userData = NULL )

Definition at line 610 of file DataChunk.cpp.

reset()

void DataChunkInput::reset

(

void

)

Definition at line 709 of file DataChunk.cpp.

Member Data Documentation

m_chunkStack

InputChunk* DataChunkInput::m_chunkStack

protected

Definition at line 182 of file DataChunk.h.

m_contents

DataChunkTableOfContents DataChunkInput::m_contents

protected

Definition at line 179 of file DataChunk.h.

m_currentObject

void* DataChunkInput::m_currentObject

Definition at line 189 of file DataChunk.h.

m_file

ChunkInputStream* DataChunkInput::m_file

protected

Definition at line 178 of file DataChunk.h.

m_fileposOfFirstChunk

Int DataChunkInput::m_fileposOfFirstChunk

protected

Definition at line 180 of file DataChunk.h.

m_parserList

UserParser* DataChunkInput::m_parserList

protected

Definition at line 181 of file DataChunk.h.

m_userData

void* DataChunkInput::m_userData

Definition at line 195 of file DataChunk.h.

---

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

• Code/GameEngine/Include/Common/DataChunk.h
• Code/GameEngine/Source/Common/System/DataChunk.cpp