ArchiveFile Class Reference
[Core]

List of all members.

Public Types
enum	SeekOrigin { SEEK_FROM_START = 0, SEEK_FROM_CURRENT = 1, SEEK_FROM_END = 2 }
Public Member Functions
	ArchiveFile (Platform_FileSystem_File *file, int offset, int size, bool sharedFile)
	ArchiveFile (const StaticBuffer *memoryBuffer, int offset, int size)
	ArchiveFile (const ArchiveFile *archiveFile)
	~ArchiveFile ()
bool	Open () const
bool	Close () const
int	GetSize () const
int	Seek (int offset, SeekOrigin origin=SEEK_FROM_START) const
int	Tell () const
int	Read (char *value, int count=1) const
int	Read (short *value, int count=1) const
int	Read (int *value, int count=1) const
int	Read (long *value, int count=1) const
int	Read (unsigned char *value, int count=1) const
int	Read (unsigned short *value, int count=1) const
int	Read (unsigned int *value, int count=1) const
int	Read (unsigned long *value, int count=1) const
int	Read (float *value, int count=1) const
int	Read (double *value, int count=1) const
int	Read (bool *value, int count=1) const

---

Detailed Description

Author:

Mattias Gustavsson

Definition at line 20 of file ArchiveFile.h.

---

Member Enumeration Documentation

enum ArchiveFile::SeekOrigin

Enumerator:

SEEK_FROM_START	Seek from the start of the file.
SEEK_FROM_CURRENT	Seek from the current position in the file.
SEEK_FROM_END	Seek from the end of the file.

Definition at line 29 of file ArchiveFile.h.

---

Constructor & Destructor Documentation

ArchiveFile::ArchiveFile	(	Platform_FileSystem_File *	file,
		int	offset,
		int	size,
		bool	sharedFile
	)

Definition at line 12 of file ArchiveFile.cpp.

ArchiveFile::ArchiveFile	(	const StaticBuffer *	memoryBuffer,
		int	offset,
		int	size
	)

Definition at line 26 of file ArchiveFile.cpp.

ArchiveFile::ArchiveFile

(

const ArchiveFile *

archiveFile

)

Definition at line 40 of file ArchiveFile.cpp.

ArchiveFile::~ArchiveFile

(

)

Definition at line 59 of file ArchiveFile.cpp.

---

Member Function Documentation

bool ArchiveFile::Open

(

)

const

Definition at line 71 of file ArchiveFile.cpp.

bool ArchiveFile::Close

(

)

const

Definition at line 80 of file ArchiveFile.cpp.

int ArchiveFile::GetSize

(

)

const

Definition at line 89 of file ArchiveFile.cpp.

int ArchiveFile::Seek	(	int	offset,
		SeekOrigin	origin = SEEK_FROM_START
	)			const

Definition at line 97 of file ArchiveFile.cpp.

int ArchiveFile::Tell

(

)

const

Definition at line 127 of file ArchiveFile.cpp.

int ArchiveFile::Read	(	char *	value,
		int	count = 1
	)			const

Definition at line 168 of file ArchiveFile.cpp.

int ArchiveFile::Read	(	short *	value,
		int	count = 1
	)			const

Definition at line 173 of file ArchiveFile.cpp.

int ArchiveFile::Read	(	int *	value,
		int	count = 1
	)			const

Definition at line 178 of file ArchiveFile.cpp.

int ArchiveFile::Read	(	long *	value,
		int	count = 1
	)			const

Definition at line 183 of file ArchiveFile.cpp.

int ArchiveFile::Read	(	unsigned char *	value,
		int	count = 1
	)			const

Definition at line 188 of file ArchiveFile.cpp.

int ArchiveFile::Read	(	unsigned short *	value,
		int	count = 1
	)			const

Definition at line 193 of file ArchiveFile.cpp.

int ArchiveFile::Read	(	unsigned int *	value,
		int	count = 1
	)			const

Definition at line 198 of file ArchiveFile.cpp.

int ArchiveFile::Read	(	unsigned long *	value,
		int	count = 1
	)			const

Definition at line 203 of file ArchiveFile.cpp.

int ArchiveFile::Read	(	float *	value,
		int	count = 1
	)			const

Definition at line 208 of file ArchiveFile.cpp.

int ArchiveFile::Read	(	double *	value,
		int	count = 1
	)			const

Definition at line 213 of file ArchiveFile.cpp.

int ArchiveFile::Read	(	bool *	value,
		int	count = 1
	)			const

Definition at line 218 of file ArchiveFile.cpp.