The base class for robots that move on a plane. More...

Inheritance diagram for RobotOnPlane:

Public Member Functions
	RobotOnPlane (ConfigurationParameters &params, QString prefix)
	Constructor.

virtual	~RobotOnPlane ()
	Destructor.

virtual bool	isKinematic () const =0
	Returns true if the robot is in kinematic mode.

virtual real	orientation (const Box2DWrapper *plane) const =0
	Returns the orientation of the robot.

virtual wVector	position () const =0
	Returns the position of the robot.

virtual real	robotHeight () const =0
	Returns the height of the robot.

virtual real	robotRadius () const =0
	Returns the radius of the robot.

virtual void	save (ConfigurationParameters &params, QString prefix)
	Saves the actual status of parameters into the ConfigurationParameters object passed.

virtual void	setOrientation (const Box2DWrapper *plane, real angle)=0
	Sets the orientation of the robot.

void	setPosition (const Box2DWrapper *plane, const wVector &pos)
	Sets the position of the robot in the plane.

virtual void	setPosition (const Box2DWrapper *plane, real x, real y)=0
	Sets the position of the robot in the plane.

Public Member Functions inherited from Robot
	Robot (ConfigurationParameters &params, QString prefix)
	Constructor.

virtual	~Robot ()
	Destructor.

Public Member Functions inherited from ParameterSettableInConstructor
	ParameterSettableInConstructor (ConfigurationParameters &, QString)

void	addObserver (RuntimeParameterObserver *obs)

T	getRuntimeParameter (QString paramName)

virtual ParameterSettableUI *	getUIManager ()

	ParameterSettable ()

virtual void	postConfigureInitialization ()

void	removeObserver (RuntimeParameterObserver *obs)

void	setRuntimeParameter (QString paramName, T newvalue)

QString	typeName () const

Public Member Functions inherited from ParameterSettable
void	addObserver (RuntimeParameterObserver *obs)

T	getRuntimeParameter (QString paramName)

void	removeObserver (RuntimeParameterObserver *obs)

void	setRuntimeParameter (QString paramName, T newvalue)

QString	typeName () const

Static Public Member Functions
static void	describe (QString type)
	Add to Factory::typeDescriptions() the descriptions of all parameters and subgroups.

Protected Member Functions
const QColor &	robotColor () const
	Returns the robot color specified by the configuration parameter.

Additional Inherited Members
Public Types inherited from ParameterSettableInConstructor
enum	Property

Public Attributes inherited from ParameterSettableInConstructor
	AllowMultiple

	Default

	IsList

	IsMandatory

Static Public Attributes inherited from ParameterSettableInConstructor
static const double	Infinity

static const int	MaxInteger

static const int	MinInteger

Static Protected Member Functions inherited from ParameterSettableInConstructor
static Descriptor	addTypeDescription (QString type, QString shortHelp, QString longHelp=QString(""))

static void	setGraphicalEditor (QString type)

Detailed Description

The base class for robots that move on a plane.

This has some utility methods common to all robots that move on a plane. There are also protected static helper methods which can be used when re-implementing in subclasses. The only parameter of this class is the color of the robot (white by default)

Definition at line 127 of file robots.h.

Constructor & Destructor Documentation

RobotOnPlane	(	ConfigurationParameters &	params,
		QString	prefix
	)

Constructor.

Parameters

params	the configuration parameters object with parameters to use
prefix	the prefix to use to access the object configuration parameters. This is guaranteed to end with the separator character when called by the factory, so you don't need to add one

Definition at line 438 of file robots.cpp.

References ConfigurationParameters::getValue(), and ConfigurationHelper::throwUserConfigError().

~RobotOnPlane ( )

virtual

Destructor.

Definition at line 461 of file robots.cpp.

Member Function Documentation

void describe ( QString type )

static

Add to Factory::typeDescriptions() the descriptions of all parameters and subgroups.

Parameters

type is the name of the type regarding the description. The type is used when a subclass reuse the description of its parent calling the parent describe method passing the type of the subclass. In this way, the result of the method describe of the parent will be the addition of the description of the parameters of the parent class into the type of the subclass

Definition at line 453 of file robots.cpp.

References ParameterSettableInConstructor::addTypeDescription(), ParameterSettable::StringDescriptor::def(), ParameterSettableInConstructor::describe(), ParameterSettable::Descriptor::describeString(), and ParameterSettable::StringDescriptor::help().

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

virtual bool isKinematic ( ) const

pure virtual

Returns true if the robot is in kinematic mode.

Returns: true if the robot is in kinematic mode

Implemented in Khepera, Epuck, and MarXbot.

Referenced by Arena::handleKinematicRobotCollisions(), and Arena::prepareToHandleKinematicRobotCollisions().

virtual real orientation ( const Box2DWrapper * plane ) const

pure virtual

Returns the orientation of the robot.

This returns the angle around the z axis of the "plane". An angle of 0 means that the X axis of the plane and of the robot are coincident (positive angles follow the right-hand rule). This function returns the angle in radiants

Parameters

plane the plane on which the robot is placed. You can use the plane returned by Arena::getPlane(), here.

Implemented in Khepera, Epuck, and MarXbot.

virtual wVector position ( ) const

pure virtual

Returns the position of the robot.

Returns: the position of the robot

Implemented in Khepera, Epuck, and MarXbot.

const QColor& robotColor ( ) const

inlineprotected

Returns the robot color specified by the configuration parameter.

Returns: the robot color specified by the configuration parameter

Definition at line 259 of file robots.h.

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

virtual real robotHeight ( ) const

pure virtual

Returns the height of the robot.

This is the height of the cylinder containing the robot. In some cases wheeled robots are modelled as cylinders to simplify calculations

Returns: the height of the robot

Implemented in Khepera, Epuck, and MarXbot.

Referenced by Arena::addRobots().

virtual real robotRadius ( ) const

pure virtual

Returns the radius of the robot.

This is the radius of the cylinder containing the robot. In some cases wheeled robots are modelled as cylinders to simplify calculations

Returns: the radius of the robot

Implemented in Khepera, Epuck, and MarXbot.

Referenced by Arena::addRobots().

void save	(	ConfigurationParameters &	params,
		QString	prefix
	)

virtual

Saves the actual status of parameters into the ConfigurationParameters object passed.

This is not implemented, calling this causes an abort

Parameters

params	the configuration parameters object on which save actual parameters
prefix	the prefix to use to access the object configuration parameters.

Implements ParameterSettableInConstructor.

Reimplemented in Khepera, Epuck, and MarXbot.

Definition at line 447 of file robots.cpp.

References Logger::error().

virtual void setOrientation	(	const Box2DWrapper *	plane,
		real	angle
	)

pure virtual

Sets the orientation of the robot.

This modifies the angle around the z axis of the "plane". An angle of 0 means that the X axis of the plane and of the robot are coincident (positive angles follow the right-hand rule). This function wants the angle in radiants

Parameters

plane	the plane on which the robot is placed. You can use the plane returned by Arena::getPlane(), here.
angle	the new orientation in radiants

Implemented in Khepera, Epuck, and MarXbot.

void setPosition	(	const Box2DWrapper *	plane,
		const wVector &	pos
	)

Sets the position of the robot in the plane.

The Z coordinate is discarded. The robot is placed on the face of the "plane" parallel to the local XY plane and with positive z coordinate. This method simply calls setPosition(real x, real y)

Parameters

plane	the plane on which the robot should be placed. You can use the plane returned by Arena::getPlane(), here.
pos	the new position (the z coordinate is discarded)

Definition at line 466 of file robots.cpp.

virtual void setPosition	(	const Box2DWrapper *	plane,
		real	x,
		real	y
	)

pure virtual

Sets the position of the robot in the plane.

The robot is placed on the face of the "plane" parallel to the local XY plane and with positive z coordinate.

Parameters

plane	the plane on which the robot should be placed. You can use the plane returned by Arena::getPlane(), here.
x	the new x coordinate
y	the new y coordinate

Implemented in Khepera, Epuck, and MarXbot.

The documentation for this class was generated from the following files:

experiments/include/robots.h
experiments/src/robots.cpp

Experiments - 1.2.3

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation