dtDIS::ResourceMapConfig Struct Reference

a structure to maintain the relationship between the DIS::EntityID and the resources available. More...

#include <sharedstate.h>

List of all members.

Public Member Functions
bool	AddResourceMapping (const DIS::EntityType &eid, const dtDAL::ResourceDescriptor &resource)
	Adds a mapping from the DIS::EntityID to the resource identifier if no mapping exists.
bool	RemoveResourceMapping (const DIS::EntityType &eid)
	Takes the one to one mapping from the container for the supplied key.
bool	GetMappedResource (const DIS::EntityType &eid, const dtDAL::ResourceDescriptor *&toWrite) const
	Introduces the ActorType mapped to the EntityID.

---

Detailed Description

a structure to maintain the relationship between the DIS::EntityID and the resources available.

---

Member Function Documentation

bool ResourceMapConfig::AddResourceMapping	(	const DIS::EntityType &	eid,
		const dtDAL::ResourceDescriptor &	resource
	)

Adds a mapping from the DIS::EntityID to the resource identifier if no mapping exists.

Returns:

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

bool ResourceMapConfig::RemoveResourceMapping

(

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 and removed from the map. false if it was not removed.

bool ResourceMapConfig::GetMappedResource	(	const DIS::EntityType &	eid,
		const dtDAL::ResourceDescriptor *&	toWrite
	)			const

Introduces the ActorType mapped to the EntityID.

Parameters:

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

Returns:

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

---