plKeyCollector Class Reference

This class is used internally by the plResManager as a storage backend for plKeys. More...

#include <plKeyCollector.h>

Public Member Functions
	plKeyCollector ()
	~plKeyCollector ()
plKey	findKey (plKey match)
void	add (plKey key)
void	del (plKey key)
void	delAll (const plLocation &loc)
void	reserveKeySpace (const plLocation &loc, short type, int num)
void	sortKeys (const plLocation &loc)
unsigned int	countTypes (const plLocation &loc, bool checkKeys=false)
unsigned int	countKeys (const plLocation &loc, bool checkKeys=false)
std::vector< plKey >	getKeys (const plLocation &loc, short type, bool checkKeys=false)
std::vector< short >	getTypes (const plLocation &loc, bool checkKeys=false)
std::vector< plLocation >	getPages ()
void	ChangeLocation (const plLocation &from, const plLocation &to)
void	MoveKey (plKey key, const plLocation &to)

Detailed Description

This class is used internally by the plResManager as a storage backend for plKeys.

It also "owns" the hsKeyedObjects referenced by its stored keys, in the manner that deleting keys from here will cause the associated hsKeyedObject to also be deleted.

Constructor & Destructor Documentation

plKeyCollector::plKeyCollector

(

)

plKeyCollector::~plKeyCollector

(

)

Member Function Documentation

void plKeyCollector::add

(

plKey

key

)

void plKeyCollector::ChangeLocation	(	const plLocation &	from,
		const plLocation &	to
	)

unsigned int plKeyCollector::countKeys	(	const plLocation &	loc,
		bool	checkKeys = false
	)

unsigned int plKeyCollector::countTypes	(	const plLocation &	loc,
		bool	checkKeys = false
	)

void plKeyCollector::del

(

plKey

key

)

void plKeyCollector::delAll

(

const plLocation &

loc

)

plKey plKeyCollector::findKey

(

plKey

match

)

std::vector<plKey> plKeyCollector::getKeys	(	const plLocation &	loc,
		short	type,
		bool	checkKeys = false
	)

std::vector<plLocation> plKeyCollector::getPages

(

)

std::vector<short> plKeyCollector::getTypes	(	const plLocation &	loc,
		bool	checkKeys = false
	)

void plKeyCollector::MoveKey	(	plKey	key,
		const plLocation &	to
	)

void plKeyCollector::reserveKeySpace	(	const plLocation &	loc,
		short	type,
		int	num
	)

void plKeyCollector::sortKeys

(

const plLocation &

loc

)

---

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

• core/ResManager/plKeyCollector.h