dtHLAGM::ObjectToActor Class Reference

Defines a one-to-one the mapping between and HLA object and a game actor. More...

#include <objecttoactor.h>

List of all members.

Public Member Functions
	ObjectToActor ()
	Constructor.
const dtDAL::ActorType &	GetActorType () const
	Gets the Game ActorType from the Object to Actor mapping.
bool	IsRemoteOnly () const
	Returns: true if this mapping should only be used for objects simulated remotely in HLA.
bool	IsLocalOnly () const
	Returns: true if this mapping should only be used for objects simulated locally.
void	SetLocalOrRemoteType (LocalOrRemoteType &newType)
	REMOTE_ONLY means this mapping should only apply to objects simulated remotely.
const std::string &	GetDDMCalculatorName () const
	Gets the name of the DDMRegionCalculator to use for subscription and publishing.
void	SetDDMCalculatorName (const std::string &newName)
	Gets the name of the DDMRegionCalculator to use for subscription and publishing.
const std::string &	GetObjectClassName () const
	Gets the HLA Object Type Name from the Object to Actor mapping.
const RTI::ObjectClassHandle	GetObjectClassHandle () const
	Gets the HLA Object Class Handle from the Object to Actor mapping.
const RTI::AttributeHandle	GetEntityIdAttributeHandle () const
	Returns: The attribute handle storing the entity id attribute.
const RTI::AttributeHandle	GetDisIDAttributeHandle () const
	Returns: The attribute handle storing the dis id attribute.
const EntityType *	GetDisID () const
	Gets the Object DIS ID from the Object to Actor mapping.
EntityType *	GetDisID ()
	Gets the Object DIS ID from the Object to Actor mapping.
const std::string &	GetEntityIdAttributeName () const
	Returns: the name of the attribute that hold the entity id or empty for not used.
void	SetEntityIdAttributeName (const std::string &newName)
	Assigns the attribute name that holds the entity id so that it can be mapped to an actor id. Set to empty string for unused.
const std::vector < AttributeToPropertyList > &	GetOneToManyMappingVector () const
std::vector < AttributeToPropertyList > &	GetOneToManyMappingVector ()
void	SetActorType (const dtDAL::ActorType &type)
	Sets the Game ActorType for this Object to Actor mapping.
void	SetObjectClassName (const std::string &objTypeName)
	Sets the HLA Object Type Name for this Object to Actor mapping.
void	SetObjectClassHandle (const RTI::ObjectClassHandle &objClassHandle)
	Sets the HLA Object Class Handle for this Object to Actor mapping.
void	SetEntityIdAttributeHandle (const RTI::AttributeHandle newEntityIdAttributeHandle)
	Sets The attribute handle storing the entity id attribute.
void	SetDisIDAttributeHandle (const RTI::AttributeHandle newDisIDAttributeHandle)
	Sets The attribute handle storing DIS Id attribute.
void	SetDisID (const EntityType *thisDisID)
	Sets the Object DIS ID for this Object to Actor mapping.
void	SetOneToManyMappingVector (std::vector< AttributeToPropertyList > &thisOneToManyMapping)
	Sets the One to One Mapping vector for this Object to Actor Mapping.
ObjectToActor &	operator= (const ObjectToActor &setTo)
bool	operator== (const ObjectToActor &toCompare) const
bool	operator!= (const ObjectToActor &toCompare) const
Classes
class	LocalOrRemoteType

---

Detailed Description

Defines a one-to-one the mapping between and HLA object and a game actor.

---

Constructor & Destructor Documentation

dtHLAGM::ObjectToActor::ObjectToActor

(

)

Constructor.

---

Member Function Documentation

const dtDAL::ActorType & dtHLAGM::ObjectToActor::GetActorType

(

)

const

Gets the Game ActorType from the Object to Actor mapping.

Returns:

the Game Actor Type

bool dtHLAGM::ObjectToActor::IsRemoteOnly

(

)

const

Returns:

true if this mapping should only be used for objects simulated remotely in HLA.

bool dtHLAGM::ObjectToActor::IsLocalOnly

(

)

const

Returns:

true if this mapping should only be used for objects simulated locally.

void dtHLAGM::ObjectToActor::SetLocalOrRemoteType

(

ObjectToActor::LocalOrRemoteType &

newType

)

REMOTE_ONLY means this mapping should only apply to objects simulated remotely.

LOCAL_ONLY if it for locally simulated ones only. LOCAL_AND_REMOTE for both. This defaults to LOCAL_AND_REMOTE.

Note:

if more than one object class/DIS ID intends to use the same actor type, only one may have this property set to anything other than REMOTE_ONLY.

if more than one actor type intends to use the same DIS ID, only one may have this property set to anything other than LOCAL_ONLY.

Parameters:

newType

the new value of the property

const std::string & dtHLAGM::ObjectToActor::GetDDMCalculatorName

(

)

const

Gets the name of the DDMRegionCalculator to use for subscription and publishing.

Returns:

the calculator name.

void dtHLAGM::ObjectToActor::SetDDMCalculatorName

(

const std::string &

newName

)

Gets the name of the DDMRegionCalculator to use for subscription and publishing.

Returns:

the calculator name.

const std::string & dtHLAGM::ObjectToActor::GetObjectClassName

(

)

const

Gets the HLA Object Type Name from the Object to Actor mapping.

Returns:

HLA Object Type Name

const RTI::ObjectClassHandle dtHLAGM::ObjectToActor::GetObjectClassHandle

(

)

const

Gets the HLA Object Class Handle from the Object to Actor mapping.

Returns:

HLA Object Class Handle

const RTI::AttributeHandle dtHLAGM::ObjectToActor::GetEntityIdAttributeHandle

(

)

const

Returns:

The attribute handle storing the entity id attribute.

const RTI::AttributeHandle dtHLAGM::ObjectToActor::GetDisIDAttributeHandle

(

)

const

Returns:

The attribute handle storing the dis id attribute.

const EntityType * dtHLAGM::ObjectToActor::GetDisID

(

)

const

Gets the Object DIS ID from the Object to Actor mapping.

Returns:

DIS ID

EntityType * dtHLAGM::ObjectToActor::GetDisID

(

)

Gets the Object DIS ID from the Object to Actor mapping.

Returns:

DIS ID

const std::string & dtHLAGM::ObjectToActor::GetEntityIdAttributeName

(

)

const

Returns:

the name of the attribute that hold the entity id or empty for not used.

void dtHLAGM::ObjectToActor::SetEntityIdAttributeName

(

const std::string &

newName

)

Assigns the attribute name that holds the entity id so that it can be mapped to an actor id. Set to empty string for unused.

const std::vector< AttributeToPropertyList > & dtHLAGM::ObjectToActor::GetOneToManyMappingVector

(

)

const

std::vector< AttributeToPropertyList > & dtHLAGM::ObjectToActor::GetOneToManyMappingVector

(

)

void dtHLAGM::ObjectToActor::SetActorType

(

const dtDAL::ActorType &

type

)

Sets the Game ActorType for this Object to Actor mapping.

Parameters:

type

the Game Actor Type

void dtHLAGM::ObjectToActor::SetObjectClassName

(

const std::string &

objTypeName

)

Sets the HLA Object Type Name for this Object to Actor mapping.

Parameters:

objTypeName

the HLA Object Type Name

void dtHLAGM::ObjectToActor::SetObjectClassHandle

(

const RTI::ObjectClassHandle &

objClassHandle

)

Sets the HLA Object Class Handle for this Object to Actor mapping.

Parameters:

objClassHandle

the HLA Object Class Handle

void dtHLAGM::ObjectToActor::SetEntityIdAttributeHandle

(

const RTI::AttributeHandle

newEntityIdAttributeHandle

)

Sets The attribute handle storing the entity id attribute.

void dtHLAGM::ObjectToActor::SetDisIDAttributeHandle

(

const RTI::AttributeHandle

newDisIDAttributeHandle

)

Sets The attribute handle storing DIS Id attribute.

void dtHLAGM::ObjectToActor::SetDisID

(

const EntityType *

thisDisID

)

Sets the Object DIS ID for this Object to Actor mapping.

Parameters:

objectDisID

the DIS ID

void dtHLAGM::ObjectToActor::SetOneToManyMappingVector

(

std::vector< AttributeToPropertyList > &

thisOneToManyMapping

)

Sets the One to One Mapping vector for this Object to Actor Mapping.

&param thisOneToManyMapping the OnetoOneMapping vector

ObjectToActor & dtHLAGM::ObjectToActor::operator=

(

const ObjectToActor &

setTo

)

bool dtHLAGM::ObjectToActor::operator==

(

const ObjectToActor &

toCompare

)

const

bool dtHLAGM::ObjectToActor::operator!=

(

const ObjectToActor &

toCompare

)

const

---