dtGame::ActorUpdateMessage Class Reference

Class the represents messages that are related to actors. More...

#include <actorupdatemessage.h>

Inheritance diagram for dtGame::ActorUpdateMessage:

List of all members.

Public Member Functions
	ActorUpdateMessage ()
	Constructor.
const std::string &	GetName () const
	Returns: The name of the actor this is updating.
void	SetName (const std::string &newName)
	This is used to change the value of the name of the actor being changed.
const std::string &	GetActorTypeName () const
	Returns: the actor type name of the actor.
void	SetActorTypeName (const std::string &newTypeName)
	This is used to change the value of the actor type name of the actor being changed.
const std::string &	GetActorTypeCategory () const
	Returns: the actor type category of the actor.
void	SetActorTypeCategory (const std::string &newTypeCategory)
	This is used to change the value of the actor type category of the actor being changed.
dtDAL::NamedParameter *	AddUpdateParameter (const std::string &name, const dtDAL::DataType &type)
	Adds an dtDAL::NamedParameter to an ActorUpdateMessage.
void	AddUpdateParameter (dtDAL::NamedParameter &paramToAdd)
	Adds a dtDAL::NamedParameter to an ActorUpdateMessage's internal GroupMessageParameter.
dtDAL::NamedParameter *	GetUpdateParameter (const std::string &name)
	Retrieves the dtDAL::NamedParameter for this actor update message for the given name.
const dtDAL::NamedParameter *	GetUpdateParameter (const std::string &name) const
	Retrieves the dtDAL::NamedParameter for this actor update message for the given name.
void	GetUpdateParameters (std::vector< dtDAL::NamedParameter * > &toFill)
	Retrieves the dtDAL::NamedParameters that have been previously added to this ActorUpdateMessage internal GroupMessageParameter.
void	GetUpdateParameters (std::vector< const MessageParameter * > &toFill) const
	Retrieves the dtDAL::NamedParameters that have been previously added to this ActorUpdateMessage internal GroupMessageParameter.
const dtDAL::ActorType *	GetActorType () const
	Gets the actor type that this message is about.
void	SetActorType (const dtDAL::ActorType &newActorType)
	Sets the actor type on this message.
Static Public Attributes
static const std::string	NAME_PARAMETER
static const std::string	ACTOR_TYPE_NAME_PARAMETER
static const std::string	ACTOR_TYPE_CATEGORY_PARAMETER
static const std::string	UPDATE_GROUP_PARAMETER
Protected Member Functions
virtual	~ActorUpdateMessage ()
	Destructor.

---

Detailed Description

Class the represents messages that are related to actors.

Additional dtDAL::NamedParameter can be added to this Message by using the AddUpdateParameter() method.

---

Constructor & Destructor Documentation

dtGame::ActorUpdateMessage::ActorUpdateMessage

(

)

Constructor.

dtGame::ActorUpdateMessage::~ActorUpdateMessage

(

)

[protected, virtual]

Destructor.

---

Member Function Documentation

const std::string & dtGame::ActorUpdateMessage::GetName

(

)

const

Returns:

The name of the actor this is updating.

This value is also used to change the name.

void dtGame::ActorUpdateMessage::SetName

(

const std::string &

newName

)

This is used to change the value of the name of the actor being changed.

Parameters:

newName

The name of the actor to set.

const std::string & dtGame::ActorUpdateMessage::GetActorTypeName

(

)

const

Returns:

the actor type name of the actor.

This can be used along with the category to create the actor.

void dtGame::ActorUpdateMessage::SetActorTypeName

(

const std::string &

newTypeName

)

This is used to change the value of the actor type name of the actor being changed.

Parameters:

newTypeName

The name of the actor type to set.

const std::string & dtGame::ActorUpdateMessage::GetActorTypeCategory

(

)

const

Returns:

the actor type category of the actor.

This can be used along with the actor type name to create the actor.

void dtGame::ActorUpdateMessage::SetActorTypeCategory

(

const std::string &

newTypeCategory

)

This is used to change the value of the actor type category of the actor being changed.

Parameters:

newTypeCategory

The category of the actor type to set.

dtDAL::NamedParameter * dtGame::ActorUpdateMessage::AddUpdateParameter	(	const std::string &	name,
		const dtDAL::DataType &	type
	)

Adds an dtDAL::NamedParameter to an ActorUpdateMessage.

Parameters:

	name	The name of the parameter to add
	type	The type of parameter it is, corresponding with dtDAL::DataType

Returns:

A pointer to the dtDAL::NamedParameter that was added to the internal GroupMessageParameter

See also:

dtDAL::DataType

Exceptions:

dtUtil::Exception

if the name specified is already used.

Note:

The returned dtDAL::NamedParameter will not show up when calling ActorUpdateMessage::GetParameter() since the parameter was actually added to an internal GroupMessageParameter, not the Message itself.

void dtGame::ActorUpdateMessage::AddUpdateParameter

(

dtDAL::NamedParameter &

paramToAdd

)

[inline]

Adds a dtDAL::NamedParameter to an ActorUpdateMessage's internal GroupMessageParameter.

Parameters:

paramToAdd

The parameter to add to the GroupMessageParameter.

Exceptions:

dtUtil::Exception

if a parameter with same name already exists.

Note:

The returned dtDAL::NamedParameter will not show up when calling ActorUpdateMessage::GetParameter() since the parameter was actually added to an internal GroupMessageParameter, not the Message itself.

dtDAL::NamedParameter * dtGame::ActorUpdateMessage::GetUpdateParameter

(

const std::string &

name

)

Retrieves the dtDAL::NamedParameter for this actor update message for the given name.

Parameters:

name

The name of the parameter to retrieve

Returns:

A pointer to the dtDAL::NamedParameter or NULL if no such parameter exists

Note:

The "update parameters" are stored in an internal GroupMessageParameter and will not be returned when calling ActorUpdateMessage::GetParameter().

const dtDAL::NamedParameter * dtGame::ActorUpdateMessage::GetUpdateParameter

(

const std::string &

name

)

const

Retrieves the dtDAL::NamedParameter for this actor update message for the given name.

Parameters:

name

The name of the parameters to retrieve

Returns:

A const pointer to the dtDAL::NamedParameter or NULL if no such parameter exists

Note:

The "update parameters" are stored in an internal GroupMessageParameter and will not be returned when calling ActorUpdateMessage::GetParameter().

void dtGame::ActorUpdateMessage::GetUpdateParameters

(

std::vector< dtDAL::NamedParameter * > &

toFill

)

Retrieves the dtDAL::NamedParameters that have been previously added to this ActorUpdateMessage internal GroupMessageParameter.

Parameters:

toFill

The vector to fill with the dtDAL::NamedParameters

Note:

The "update parameters" are stored in an internal GroupMessageParameter and will not be returned when calling ActorUpdateMessage::GetParameter().

void dtGame::ActorUpdateMessage::GetUpdateParameters

(

std::vector< const MessageParameter * > &

toFill

)

const

Retrieves the dtDAL::NamedParameters that have been previously added to this ActorUpdateMessage internal GroupMessageParameter.

Parameters:

toFill

The vector to fill with the const dtDAL::NamedParameters

Note:

The "update parameters" are stored in an internal GroupMessageParameter and will not be returned when calling ActorUpdateMessage::GetParameter().

const dtDAL::ActorType * dtGame::ActorUpdateMessage::GetActorType

(

)

const

Gets the actor type that this message is about.

Returns:

The actor type or NULL if the current name and category do not exist

void dtGame::ActorUpdateMessage::SetActorType

(

const dtDAL::ActorType &

newActorType

)

Sets the actor type on this message.

Parameters:

newActorType

the actor type on this actor

---

Member Data Documentation

const std::string dtGame::ActorUpdateMessage::NAME_PARAMETER [static]

const std::string dtGame::ActorUpdateMessage::ACTOR_TYPE_NAME_PARAMETER [static]

const std::string dtGame::ActorUpdateMessage::ACTOR_TYPE_CATEGORY_PARAMETER [static]

const std::string dtGame::ActorUpdateMessage::UPDATE_GROUP_PARAMETER [static]

---