CObjTypePool Class Reference

Stores the ids of GEs by their CCmpObjType values. More...

#include <objTypePool.h>

List of all members.

Static Public Member Functions
static void	clear ()
	Clear out all data.
static void	set (OBJTYPE_DATA &obj)
	Add or Change Object Type data in the pool.
static const OBJTYPE_DATA *	get (long id)
static bool	get (OBJTYPE_DATA *pObj, long id)
	Set the data of the Obj Type passed to the matching id's data (or zero if no data found).
static bool	valid (const long &id)
	Is there a record for this ID?
static int	size ()
	Returns: The number of entries.
static const OBJTYPE_DATA *	begin ()
static const OBJTYPE_DATA *	next ()
	Used to iterate through the pool (call begin() to start at the front).
Static Protected Member Functions
static CObjTypePool *	instance ()
	Used by the static methods for a central data store.

---

Detailed Description

Stores the ids of GEs by their CCmpObjType values.

Used to quicly look up all GEs of a certain type.

(c) 2007-2008 oP group Germany GbR. All rights reserved.
This source code is provided "as is" with no warranty and must not be distributed without written permission.

Author:

Doug Poston

Version:

1.3

Date:

12/28/2007

---

Member Function Documentation

void CObjTypePool::set

(

OBJTYPE_DATA &

obj

)

[static]

Add or Change Object Type data in the pool.

Parameters:

obj

The Object Type data to add or change.

const OBJTYPE_DATA * CObjTypePool::get

(

long

id

)

[static]

Parameters:

id

The GE id whos Object Type data we want.

Returns:

A pointer to the Object Type data associated with the id (NULL if none).

bool CObjTypePool::get	(	OBJTYPE_DATA *	pObj,
		long	id
	)			[static]

Set the data of the Obj Type passed to the matching id's data (or zero if no data found).

Parameters:

	pObj	Pointer to an Object Type data record with the matching id.
	id	The GE id whos Object Type data we want.

Returns:

true if a data record was found.

bool CObjTypePool::valid

(

const long &

id

)

[static]

Is there a record for this ID?

Returns:

true If a record exisits.

const OBJTYPE_DATA * CObjTypePool::begin

(

)

[static]

Returns:

A pointer to the first object stored in this pool (NULL if none).

See also:

next()

const OBJTYPE_DATA * CObjTypePool::next

(

)

[static]

Used to iterate through the pool (call begin() to start at the front).

Returns:

A pointer to the next object stored in this pool (NULL if none).

See also:

begin()

---

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

• C:/Documents and Settings/slap/My Documents/Visual Studio 2005/Projects/Template7/template7/objTypePool.h
• C:/Documents and Settings/slap/My Documents/Visual Studio 2005/Projects/Template7/template7/objTypePool.cpp

---