dtHLAGM::ObjectRuntimeMappingInfo Class Reference

Simple class that holds all of the data used at runtime when mapping RTI objects to actor types. More...

#include <objectruntimemappinginfo.h>

List of all members.

Public Member Functions
	ObjectRuntimeMappingInfo ()
	~ObjectRuntimeMappingInfo ()
bool	Put (const std::string &rtiId, const dtCore::UniqueId &actorId)
	Bidirectionally maps the given RTI id string (RTIObjectIdentifierStruct) to the actor id.
bool	Put (const RTI::ObjectHandle handle, const dtCore::UniqueId &actorId)
	Bidirectionally maps the given object handle to the unique id.
bool	Put (const EntityIdentifier &entityId, const dtCore::UniqueId &actorId)
	Bidirectionally maps the given entity id to the unique id.
bool	Put (const RTI::ObjectHandle handle, ObjectToActor &ota)
	Maps the given object handle to the object to actor.
const dtCore::UniqueId *	GetId (const RTI::ObjectHandle handle) const
	Returns: the unique id that was mapped to given object handle or NULL if none has been mapped
const dtCore::UniqueId *	GetId (const EntityIdentifier &entityId) const
	Returns: the unique id that was mapped to given entity id or NULL if none has been mapped
const dtCore::UniqueId *	GetIdByRTIId (const std::string &rtiId) const
	Returns: the unique id that was mapped to given rti string id or NULL if none has been mapped
const std::string *	GetRTIId (const dtCore::UniqueId &actorId) const
	Returns: the rti string id that was mapped to given unique id or NULL if none has been mapped
const RTI::ObjectHandle *	GetHandle (const dtCore::UniqueId &actorId) const
	Returns: the object handle that was mapped to given unique id or NULL if none has been mapped
const EntityIdentifier *	GetEntityId (const dtCore::UniqueId &actorId) const
	Returns: the entity id that was mapped to given unique id or NULL if none has been mapped
const ObjectToActor *	GetObjectToActor (const RTI::ObjectHandle handle) const
	Returns: the object to actor that was mapped to given object handle or NULL if none has been mapped
ObjectToActor *	GetObjectToActor (const RTI::ObjectHandle handle)
	Returns: the object to actor that was mapped to given object handle or NULL if none has been mapped
void	Remove (const RTI::ObjectHandle handle)
	Removes all mappings for the given handle including a unique id, an object to actor, and an entity id id mapped to the unique id.
void	Remove (const EntityIdentifier &entityId)
	Removes the mapping to a unique id for the given entity id.
void	Remove (const dtCore::UniqueId &actorId)
	Removes the mapping to an object handle and an entity id for the given unique id.
void	Clear ()
	Removes all mappings in the instance.
void	GetAllActorIds (std::vector< dtCore::UniqueId > &toFill) const
	Returns: a list of all existing actors in the mapping file that are mapped to RTI object handles.

---

Detailed Description

Simple class that holds all of the data used at runtime when mapping RTI objects to actor types.

---

Constructor & Destructor Documentation

dtHLAGM::ObjectRuntimeMappingInfo::ObjectRuntimeMappingInfo

(

)

dtHLAGM::ObjectRuntimeMappingInfo::~ObjectRuntimeMappingInfo

(

)

---

Member Function Documentation

bool dtHLAGM::ObjectRuntimeMappingInfo::Put	(	const std::string &	rtiId,
		const dtCore::UniqueId &	actorId
	)

Bidirectionally maps the given RTI id string (RTIObjectIdentifierStruct) to the actor id.

Returns:

false if either object is already involved in another like mapping.

bool dtHLAGM::ObjectRuntimeMappingInfo::Put	(	const RTI::ObjectHandle	handle,
		const dtCore::UniqueId &	actorId
	)

Bidirectionally maps the given object handle to the unique id.

Returns:

false if either object is already involved in another like mapping.

bool dtHLAGM::ObjectRuntimeMappingInfo::Put	(	const EntityIdentifier &	entityId,
		const dtCore::UniqueId &	actorId
	)

Bidirectionally maps the given entity id to the unique id.

Returns:

false if either object is already involved in another like mapping.

bool dtHLAGM::ObjectRuntimeMappingInfo::Put	(	const RTI::ObjectHandle	handle,
		ObjectToActor &	ota
	)

Maps the given object handle to the object to actor.

Returns:

false if an object to actor is already mapped to the handle passed in.

const dtCore::UniqueId * dtHLAGM::ObjectRuntimeMappingInfo::GetId

(

const RTI::ObjectHandle

handle

)

const

Returns:

the unique id that was mapped to given object handle or NULL if none has been mapped

const dtCore::UniqueId * dtHLAGM::ObjectRuntimeMappingInfo::GetId

(

const EntityIdentifier &

entityId

)

const

Returns:

the unique id that was mapped to given entity id or NULL if none has been mapped

const dtCore::UniqueId * dtHLAGM::ObjectRuntimeMappingInfo::GetIdByRTIId

(

const std::string &

rtiId

)

const

Returns:

the unique id that was mapped to given rti string id or NULL if none has been mapped

const std::string * dtHLAGM::ObjectRuntimeMappingInfo::GetRTIId

(

const dtCore::UniqueId &

actorId

)

const

Returns:

the rti string id that was mapped to given unique id or NULL if none has been mapped

const RTI::ObjectHandle * dtHLAGM::ObjectRuntimeMappingInfo::GetHandle

(

const dtCore::UniqueId &

actorId

)

const

Returns:

the object handle that was mapped to given unique id or NULL if none has been mapped

const EntityIdentifier * dtHLAGM::ObjectRuntimeMappingInfo::GetEntityId

(

const dtCore::UniqueId &

actorId

)

const

Returns:

the entity id that was mapped to given unique id or NULL if none has been mapped

const ObjectToActor * dtHLAGM::ObjectRuntimeMappingInfo::GetObjectToActor

(

const RTI::ObjectHandle

handle

)

const

Returns:

the object to actor that was mapped to given object handle or NULL if none has been mapped

ObjectToActor * dtHLAGM::ObjectRuntimeMappingInfo::GetObjectToActor

(

const RTI::ObjectHandle

handle

)

Returns:

the object to actor that was mapped to given object handle or NULL if none has been mapped

void dtHLAGM::ObjectRuntimeMappingInfo::Remove

(

const RTI::ObjectHandle

handle

)

Removes all mappings for the given handle including a unique id, an object to actor, and an entity id id mapped to the unique id.

void dtHLAGM::ObjectRuntimeMappingInfo::Remove

(

const EntityIdentifier &

entityId

)

Removes the mapping to a unique id for the given entity id.

This will also remove the object handle mapped to the unique id and the object to actor mapped to the object handle.

void dtHLAGM::ObjectRuntimeMappingInfo::Remove

(

const dtCore::UniqueId &

actorId

)

Removes the mapping to an object handle and an entity id for the given unique id.

This will also remove the object to actor mapped to the object handle; and remove the RTI id string mapping to the actor id.

void dtHLAGM::ObjectRuntimeMappingInfo::Clear

(

)

Removes all mappings in the instance.

void dtHLAGM::ObjectRuntimeMappingInfo::GetAllActorIds

(

std::vector< dtCore::UniqueId > &

toFill

)

const

Returns:

a list of all existing actors in the mapping file that are mapped to RTI object handles.

---