dtHLAGM::RPRParameterTranslator Class Reference

#include <rprparametertranslator.h>

Inheritance diagram for dtHLAGM::RPRParameterTranslator:

List of all members.

Public Member Functions
	RPRParameterTranslator (dtUtil::Coordinates &coordinates, ObjectRuntimeMappingInfo &runtimeMappings)
virtual void	MapToMessageParameters (const char *buffer, size_t size, std::vector< dtCore::RefPtr< dtGame::MessageParameter > > &parameters, const OneToManyMapping &mapping) const
virtual void	MapFromMessageParameters (char *buffer, size_t &maxSize, std::vector< dtCore::RefPtr< const dtGame::MessageParameter > > &parameters, const OneToManyMapping &mapping) const
virtual const AttributeType &	GetAttributeTypeForName (const std::string &name) const
	Returns: the attribute type this translator uses for this name.
virtual bool	TranslatesAttributeType (const AttributeType &type) const
	Returns: true if this translator supports the given type.
Protected Member Functions
virtual	~RPRParameterTranslator ()
const std::string	GetEnumValue (const std::string &value, const OneToManyMapping::ParameterDefinition &paramDef, bool returnGameValue) const
	Helper method to map between the hla and game value enum values.
void	SetIntegerValue (unsigned value, dtGame::MessageParameter &parameter, const OneToManyMapping &mapping, unsigned parameterDefIndex) const
unsigned	GetIntegerValue (const dtGame::MessageParameter &parameter, const OneToManyMapping &mapping, unsigned parameterDefIndex) const
osg::Vec3d	CoordConvertPositionParameter (const dtGame::MessageParameter &parameter) const
osg::Vec3d	CoordConvertRotationParameter (const dtGame::MessageParameter &parameter) const
osg::Vec3f	CoordConvertVelocityParameter (const dtGame::MessageParameter &parameter) const
osg::Vec3f	CoordConvertAngularVelocityParameter (const dtGame::MessageParameter &parameter) const
void	CoordConvertWorldCoord (const WorldCoordinate &worldCoord, dtGame::MessageParameter &parameter) const
void	CoordConvertOrientation (const EulerAngles &vec, dtGame::MessageParameter &parameter) const
void	CoordConvertVelocityVector (const VelocityVector &vec, dtGame::MessageParameter &parameter) const
void	CoordConvertAngularVelocityVector (const VelocityVector &vec, dtGame::MessageParameter &parameter) const
void	MapFromParamsToSpatial (char *buffer, size_t &maxSize, std::vector< dtCore::RefPtr< const dtGame::MessageParameter > > &parameters, const OneToManyMapping &mapping) const
	This expects to find the parameters in the order Dead reckoning algorithm, frozen, world position, orientation, velocity, acceleration, and angular velocity.
void	MapFromParamToWorldCoord (char *buffer, const size_t maxSize, const dtGame::MessageParameter &parameter) const
void	MapFromParamToEulerAngles (char *buffer, const size_t maxSize, const dtGame::MessageParameter &parameter) const
void	MapFromParamToVelocityVector (char *buffer, const size_t maxSize, const dtGame::MessageParameter &parameter) const
void	MapFromParamToAngularVelocityVector (char *buffer, const size_t maxSize, const dtGame::MessageParameter &parameter) const
void	MapFromParamToEntityType (char *buffer, const size_t maxSize, const dtGame::MessageParameter &parameter, const OneToManyMapping &mapping, const OneToManyMapping::ParameterDefinition &paramDef) const
void	MapFromParamToArticulations (char *buffer, size_t &maxSize, const dtGame::MessageParameter &parameter, const OneToManyMapping::ParameterDefinition &paramDef) const
void	MapFromStringParamToCharArray (char *buffer, size_t &maxSize, const dtGame::StringMessageParameter &parameter, const OneToManyMapping::ParameterDefinition &paramDef, const dtDAL::DataType &parameterDataType) const
void	MapFromSpatialToMessageParams (const char *buffer, const size_t maxSize, std::vector< dtCore::RefPtr< dtGame::MessageParameter > > &parameters, const OneToManyMapping &mapping) const
void	MapFromWorldCoordToMessageParam (const char *buffer, const size_t size, dtGame::MessageParameter &parameter) const
void	MapFromEulerAnglesToMessageParam (const char *buffer, const size_t size, dtGame::MessageParameter &parameter) const
void	MapFromVelocityVectorToMessageParam (const char *buffer, const size_t size, dtGame::MessageParameter &parameter) const
void	MapFromAngularVelocityVectorToMessageParam (const char *buffer, const size_t size, dtGame::MessageParameter &parameter) const
void	MapFromCharArrayToStringParam (const char *buffer, const size_t size, dtGame::StringMessageParameter &parameter, const OneToManyMapping::ParameterDefinition &paramDef) const
void	MapFromArticulationsToMessageParam (const char *buffer, const size_t size, dtGame::MessageParameter &parameter, const dtDAL::DataType &parameterDataType, const OneToManyMapping::ParameterDefinition &paramDef) const
Protected Attributes
dtUtil::Log *	mLogger
dtUtil::Coordinates &	mCoordinates
ObjectRuntimeMappingInfo &	mRuntimeMappings

---

Constructor & Destructor Documentation

dtHLAGM::RPRParameterTranslator::RPRParameterTranslator	(	dtUtil::Coordinates &	coordinates,
		ObjectRuntimeMappingInfo &	runtimeMappings
	)

dtHLAGM::RPRParameterTranslator::~RPRParameterTranslator

(

)

[protected, virtual]

---

Member Function Documentation

void dtHLAGM::RPRParameterTranslator::MapToMessageParameters	(	const char *	buffer,
		size_t	size,
		std::vector< dtCore::RefPtr< dtGame::MessageParameter > > &	parameters,
		const OneToManyMapping &	mapping
	)			const [virtual]

Implements dtHLAGM::ParameterTranslator.

void dtHLAGM::RPRParameterTranslator::MapFromMessageParameters	(	char *	buffer,
		size_t &	maxSize,
		std::vector< dtCore::RefPtr< const dtGame::MessageParameter > > &	parameters,
		const OneToManyMapping &	mapping
	)			const [virtual]

Implements dtHLAGM::ParameterTranslator.

const AttributeType & dtHLAGM::RPRParameterTranslator::GetAttributeTypeForName

(

const std::string &

name

)

const [virtual]

Returns:

the attribute type this translator uses for this name.

It will return AttributeType::UNKNOWN if the name doesn't match anything.

Implements dtHLAGM::ParameterTranslator.

bool dtHLAGM::RPRParameterTranslator::TranslatesAttributeType

(

const AttributeType &

type

)

const [virtual]

Returns:

true if this translator supports the given type.

Implements dtHLAGM::ParameterTranslator.

const std::string dtHLAGM::RPRParameterTranslator::GetEnumValue	(	const std::string &	value,
		const OneToManyMapping::ParameterDefinition &	paramDef,
		bool	returnGameValue
	)			const [protected]

Helper method to map between the hla and game value enum values.

Parameters:

	value	the hla or game value we need the mapping for.
	paramDef	the parameter definition that should hold the mapping.
	returnGameValue	true if "value" is the hla value an we want the game value. False for the opposite.

Returns:

the mapped value, the default if no mapping is found, or empty string if the default fails.

void dtHLAGM::RPRParameterTranslator::SetIntegerValue	(	unsigned	value,
		dtGame::MessageParameter &	parameter,
		const OneToManyMapping &	mapping,
		unsigned	parameterDefIndex
	)			const [protected]

unsigned dtHLAGM::RPRParameterTranslator::GetIntegerValue	(	const dtGame::MessageParameter &	parameter,
		const OneToManyMapping &	mapping,
		unsigned	parameterDefIndex
	)			const [protected]

osg::Vec3d dtHLAGM::RPRParameterTranslator::CoordConvertPositionParameter

(

const dtGame::MessageParameter &

parameter

)

const [protected]

osg::Vec3d dtHLAGM::RPRParameterTranslator::CoordConvertRotationParameter

(

const dtGame::MessageParameter &

parameter

)

const [protected]

osg::Vec3f dtHLAGM::RPRParameterTranslator::CoordConvertVelocityParameter

(

const dtGame::MessageParameter &

parameter

)

const [protected]

osg::Vec3f dtHLAGM::RPRParameterTranslator::CoordConvertAngularVelocityParameter

(

const dtGame::MessageParameter &

parameter

)

const [protected]

void dtHLAGM::RPRParameterTranslator::CoordConvertWorldCoord	(	const WorldCoordinate &	worldCoord,
		dtGame::MessageParameter &	parameter
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::CoordConvertOrientation	(	const EulerAngles &	vec,
		dtGame::MessageParameter &	parameter
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::CoordConvertVelocityVector	(	const VelocityVector &	vec,
		dtGame::MessageParameter &	parameter
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::CoordConvertAngularVelocityVector	(	const VelocityVector &	vec,
		dtGame::MessageParameter &	parameter
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::MapFromParamsToSpatial	(	char *	buffer,
		size_t &	maxSize,
		std::vector< dtCore::RefPtr< const dtGame::MessageParameter > > &	parameters,
		const OneToManyMapping &	mapping
	)			const [protected]

This expects to find the parameters in the order Dead reckoning algorithm, frozen, world position, orientation, velocity, acceleration, and angular velocity.

Frozen may be omitted

TODO verify the value of drCode is in range.

void dtHLAGM::RPRParameterTranslator::MapFromParamToWorldCoord	(	char *	buffer,
		const size_t	maxSize,
		const dtGame::MessageParameter &	parameter
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::MapFromParamToEulerAngles	(	char *	buffer,
		const size_t	maxSize,
		const dtGame::MessageParameter &	parameter
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::MapFromParamToVelocityVector	(	char *	buffer,
		const size_t	maxSize,
		const dtGame::MessageParameter &	parameter
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::MapFromParamToAngularVelocityVector	(	char *	buffer,
		const size_t	maxSize,
		const dtGame::MessageParameter &	parameter
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::MapFromParamToEntityType	(	char *	buffer,
		const size_t	maxSize,
		const dtGame::MessageParameter &	parameter,
		const OneToManyMapping &	mapping,
		const OneToManyMapping::ParameterDefinition &	paramDef
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::MapFromParamToArticulations	(	char *	buffer,
		size_t &	maxSize,
		const dtGame::MessageParameter &	parameter,
		const OneToManyMapping::ParameterDefinition &	paramDef
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::MapFromStringParamToCharArray	(	char *	buffer,
		size_t &	maxSize,
		const dtGame::StringMessageParameter &	parameter,
		const OneToManyMapping::ParameterDefinition &	paramDef,
		const dtDAL::DataType &	parameterDataType
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::MapFromSpatialToMessageParams	(	const char *	buffer,
		const size_t	maxSize,
		std::vector< dtCore::RefPtr< dtGame::MessageParameter > > &	parameters,
		const OneToManyMapping &	mapping
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::MapFromWorldCoordToMessageParam	(	const char *	buffer,
		const size_t	size,
		dtGame::MessageParameter &	parameter
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::MapFromEulerAnglesToMessageParam	(	const char *	buffer,
		const size_t	size,
		dtGame::MessageParameter &	parameter
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::MapFromVelocityVectorToMessageParam	(	const char *	buffer,
		const size_t	size,
		dtGame::MessageParameter &	parameter
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::MapFromAngularVelocityVectorToMessageParam	(	const char *	buffer,
		const size_t	size,
		dtGame::MessageParameter &	parameter
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::MapFromCharArrayToStringParam	(	const char *	buffer,
		const size_t	size,
		dtGame::StringMessageParameter &	parameter,
		const OneToManyMapping::ParameterDefinition &	paramDef
	)			const [protected]

void dtHLAGM::RPRParameterTranslator::MapFromArticulationsToMessageParam	(	const char *	buffer,
		const size_t	size,
		dtGame::MessageParameter &	parameter,
		const dtDAL::DataType &	parameterDataType,
		const OneToManyMapping::ParameterDefinition &	paramDef
	)			const [protected]

---

Member Data Documentation

dtUtil::Log* dtHLAGM::RPRParameterTranslator::mLogger [protected]

dtUtil::Coordinates& dtHLAGM::RPRParameterTranslator::mCoordinates [protected]

ObjectRuntimeMappingInfo& dtHLAGM::RPRParameterTranslator::mRuntimeMappings [protected]

---