ResourceObject Class Reference

#include <resourceManager.h>

Public Types
enum	Flags { VolumeBlock = BIT(0) , File = BIT(1) , Added = BIT(2) }

Public Member Functions
	ResourceObject ()
	~ResourceObject ()
void	destruct ()
void	getFileTimes (FileTime *createTime, FileTime *modifyTime)
List Management
ResourceObject *	getNext () const
void	unlink ()
void	linkAfter (ResourceObject *res)

Public Attributes
S32	flags
	Set from Flags.
StringTableEntry	path
	Resource path.
StringTableEntry	name
	Resource name.
ResourceInstance *	mInstance
S32	lockCount
	Lock count; used to control load/unload of resource from memory.
U32	crc
	CRC of resource.
Zip::ZipArchive *	mZipArchive
	The zip archive for reading from zips.
const Zip::CentralDir *	mCentralDir
	The central directory for this file in the zip.
ZIP Archive
If the resource is stored in a zip file, these members are populated.
StringTableEntry	zipPath
	Path of zip file.
StringTableEntry	zipName
	Name of zip file.
S32	fileOffset
	Offset of data in zip file.
S32	fileSize
	Size on disk of resource block.
S32	compressedFileSize
	Actual size of resource data.

Friends
class	ResDictionary
class	ResManager

Detailed Description

Wrapper around a ResourceInstance.

This contains all the book-keeping data used by ResDictionary and ResManager.

See also

ResManager

Member Enumeration Documentation

Flags

enum Flags

Enumerator
VolumeBlock
File
Added

Constructor & Destructor Documentation

ResourceObject()

ResourceObject

(

)

~ResourceObject()

~ResourceObject ( )

inline

Member Function Documentation

destruct()

void destruct

(

)

getFileTimes()

void getFileTimes	(	FileTime *	createTime,
		FileTime *	modifyTime
	)

Get some information about file times.

Parameters

createTime	Pointer to a FileTime structure to fill with information about when this object was created.
modifyTime	Pointer to a FileTime structure to fill with information about when this object was modified.

getNext()

ResourceObject * getNext ( ) const

inline

linkAfter()

void linkAfter ( ResourceObject *  res )

inline

unlink()

void unlink ( )

inline

Friends And Related Symbol Documentation

ResDictionary

friend class ResDictionary

friend

ResManager

friend class ResManager

friend

Member Data Documentation

compressedFileSize

S32 compressedFileSize

Actual size of resource data.

crc

U32 crc

CRC of resource.

fileOffset

S32 fileOffset

Offset of data in zip file.

fileSize

S32 fileSize

Size on disk of resource block.

flags

S32 flags

Set from Flags.

lockCount

S32 lockCount

Lock count; used to control load/unload of resource from memory.

mCentralDir

const Zip::CentralDir* mCentralDir

The central directory for this file in the zip.

mInstance

ResourceInstance* mInstance

Pointer to actual object instance. If the object is not loaded, this may be NULL or garbage.

mZipArchive

Zip::ZipArchive* mZipArchive

The zip archive for reading from zips.

name

StringTableEntry name

Resource name.

path

StringTableEntry path

Resource path.

zipName

StringTableEntry zipName

Name of zip file.

zipPath

StringTableEntry zipPath

Path of zip file.

---

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

• io/resource/resourceManager.h
• io/resource/resourceManager.cc