dtDIS::ActorMapConfig Struct Reference

a structure to maintain the one-to-one relationship between the DIS::EntityID and the dtDAL::ActorType. More...

#include <sharedstate.h>

List of all members.

Public Member Functions
bool	AddActorMapping (const DIS::EntityType &eid, const dtDAL::ActorType *at)
	Adds a mapping from the DIS::EntityID to the dtDAL::ActorType if no mapping exists.
bool	RemoveActorMapping (const DIS::EntityType &eid)
	Takes the one to one mapping from the container for the supplied key.
bool	GetMappedActor (const DIS::EntityType &eid, const dtDAL::ActorType *&toWrite)
	Introduces the ActorType mapped to the EntityID.

---

Detailed Description

a structure to maintain the one-to-one relationship between the DIS::EntityID and the dtDAL::ActorType.

---

Member Function Documentation

bool ActorMapConfig::AddActorMapping	(	const DIS::EntityType &	eid,
		const dtDAL::ActorType *	at
	)

Adds a mapping from the DIS::EntityID to the dtDAL::ActorType if no mapping exists.

Returns:

true if no previous mapping existed. false if a mapping existed already.

bool ActorMapConfig::RemoveActorMapping

(

const DIS::EntityType &

eid

)

Takes the one to one mapping from the container for the supplied key.

Parameters:

eid

the key to the mapping.

Returns:

true if eid was found in the map. false if it was not found.

bool ActorMapConfig::GetMappedActor	(	const DIS::EntityType &	eid,
		const dtDAL::ActorType *&	toWrite
	)

Introduces the ActorType mapped to the EntityID.

Parameters:

	toWrite	Overwritten with the instance of the mapped ActorType.
	eid	The key being stored.

Returns:

true if eid was found in the map. false if it was not found.

---