farsa::robotConfigurationUtilities Namespace Reference

This namespace contains utility functions for robot configuration. More...

Functions
QString	extractRobotName (ConfigurationParameters &params, QString prefix, QString defaultName)
	Gets the name of the robot. More...
wMatrix	extractRobotTranformation (ConfigurationParameters &params, QString prefix)
	Gets the transformation matrix of the robot. More...
World *	extractWorld (ConfigurationParameters &params)
	Gets the resource for world. More...

Detailed Description

This namespace contains utility functions for robot configuration.

Function Documentation

FARSA_EXPERIMENTS_API QString extractRobotName	(	ConfigurationParameters &	params,
		QString	prefix,
		QString	defaultName
	)

Gets the name of the robot.

Parameters

params	the configuration parameter object
prefix	the prefix to use
defaultName	the default name of the robot

Returns

the name of the robot

Definition at line 45 of file robots.cpp.

References ConfigurationHelper::getString().

Referenced by Epuck::Epuck(), Khepera::Khepera(), and MarXbot::MarXbot().

FARSA_EXPERIMENTS_API wMatrix extractRobotTranformation	(	ConfigurationParameters &	params,
		QString	prefix
	)

Gets the transformation matrix of the robot.

Parameters

params	the configuration parameter object
prefix	the prefix to use

Returns

the transformation matrix for the robot

Definition at line 50 of file robots.cpp.

References ConfigurationHelper::getString(), wMatrix::identity(), and ConfigurationHelper::throwUserConfigError().

Referenced by Epuck::Epuck(), Khepera::Khepera(), and MarXbot::MarXbot().

FARSA_EXPERIMENTS_API World * extractWorld

(

ConfigurationParameters &

params

)

Gets the resource for world.

Parameters

params

the configuration parameter object

Returns

a pointer to the world

Definition at line 34 of file robots.cpp.

References SimpleResourcesUser::getResource(), ConfigurationParameters::getResourcesUserForResource(), and ConfigurationHelper::throwUserMissingResourceError().

Referenced by Epuck::Epuck(), Khepera::Khepera(), and MarXbot::MarXbot().