MarXbot Class Reference

The class modelling the marXbot robot. More...

Inheritance diagram for MarXbot:

Public Member Functions
	MarXbot (ConfigurationParameters &params, QString prefix)
	Constructor.
virtual	~MarXbot ()
	Destructor.
virtual bool	isKinematic () const
	Returns true if the robot is in kinematic mode.
virtual real	orientation (const Box2DWrapper *plane) const
	Returns the orientation of the robot.
virtual wVector	position () const
	Returns the position of the robot.
virtual real	robotHeight () const
	Returns the height of the robot.
virtual real	robotRadius () const
	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)
	Sets the orientation of the robot.
virtual void	setPosition (const Box2DWrapper *plane, real x, real y)
	Sets the position of the robot in the plane.
Public Member Functions inherited from RobotOnPlane
	RobotOnPlane (ConfigurationParameters &params, QString prefix)
	Constructor.
virtual	~RobotOnPlane ()
	Destructor.
void	setPosition (const Box2DWrapper *plane, const wVector &pos)
	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
Public Member Functions inherited from PhyMarXbot
	PhyMarXbot (World *world, QString name, const wMatrix &tm=wMatrix::identity())
PhyObject *	attachmentDevice ()
MarXbotAttachmentDeviceMotorController *	attachmentDeviceController ()
bool	attachmentDeviceEnabled () const
PhyHinge *	attachmentDeviceJoint ()
PhyObject *	base ()
QColor	color () const
void	doKinematicSimulation (bool k)
void	enableAttachmentDevice (bool enable)
bool	getDrawFrontMarker () const
IRSensorController *	groundAroundIRSensorController ()
IRSensorController *	groundBottomIRSensorController ()
bool	isInvisible ()
bool	isKinematic () const
const wMatrix &	matrix () const
QString	name () const
	Ownable ()
const QList< Owned > &	owned () const
Ownable *	owner () const
virtual void	postUpdate ()
virtual void	preUpdate ()
IRSensorController *	proximityIRSensorController ()
void	resetAttachmentDevice ()
void	setAlpha (int alpha)
void	setColor (QColor c)
void	setDrawFrontMarker (bool drawMarker)
void	setGroundAroundIRSensorsGraphicalProperties (bool drawSensor, bool drawRay=false, bool drawRealRay=false)
void	setGroundBottomIRSensorsGraphicalProperties (bool drawSensor, bool drawRay=false, bool drawRealRay=false)
void	setInvisible (bool b)
void	setMatrix (const wMatrix &newm)
void	setOwner (Ownable *owner, bool destroy=true)
void	setPosition (real x, real y, real z)
void	setPosition (const wVector &newpos)
void	setProximityIRSensorsGraphicalProperties (bool drawSensor, bool drawRay=false, bool drawRealRay=false)
void	setTexture (QString textureName)
void	setUseColorTextureOfOwner (bool b)
QString	texture () const
TractionSensorController *	tractionSensorController ()
PhyObject *	turret ()
bool	useColorTextureOfOwner () const
WheelMotorController *	wheelsController ()
	WObject (World *world, QString name="unamed", const wMatrix &tm=wMatrix::identity(), bool addToWorld=true)
World *	world ()
const World *	world () const
Public Member Functions inherited from WObject
	WObject (World *world, QString name="unamed", const wMatrix &tm=wMatrix::identity(), bool addToWorld=true)
QColor	color () const
bool	isInvisible ()
const wMatrix &	matrix () const
QString	name () const
	Ownable ()
const QList< Owned > &	owned () const
Ownable *	owner () const
void	setAlpha (int alpha)
void	setColor (QColor c)
void	setInvisible (bool b)
void	setMatrix (const wMatrix &newm)
void	setOwner (Ownable *owner, bool destroy=true)
void	setPosition (const wVector &newpos)
void	setPosition (real x, real y, real z)
void	setTexture (QString textureName)
void	setUseColorTextureOfOwner (bool b)
QString	texture () const
bool	useColorTextureOfOwner () const
World *	world ()
const World *	world () const
Public Member Functions inherited from Ownable
const QList< Owned > &	owned () const
Ownable *	owner () const
void	setOwner (Ownable *owner, bool destroy=true)

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

Additional Inherited Members
Public Types inherited from ParameterSettableInConstructor
enum	Property
Public Types inherited from PhyMarXbot
typedef QList< Owned >	OwnedList
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 Public Attributes inherited from PhyMarXbot
static const real	attachdevm
static const real	attachdevr
static const real	attachdevx
static const real	attachdevy
static const real	attachdevz
static const real	axledistance
static const real	basem
static const real	basex
static const real	basey
static const real	basez
static const real	bodyh
static const real	bodym
static const real	bodyr
static const real	trackheight
static const real	trackm
static const real	trackradius
static const real	treaddepth
static const real	turreth
static const real	turretm
static const real	wheelh
static const real	wheelm
static const real	wheelr
Protected Slots inherited from PhyMarXbot
void	setLeftWheelDesideredVelocity (real velocity)
void	setRightWheelDesideredVelocity (real velocity)
Protected Member Functions inherited from RobotOnPlane
const QColor &	robotColor () const
	Returns the robot color specified by the configuration parameter.
Protected Member Functions inherited from PhyMarXbot
virtual void	changedMatrix ()
Static Protected Member Functions inherited from ParameterSettableInConstructor
static Descriptor	addTypeDescription (QString type, QString shortHelp, QString longHelp=QString(""))
static void	setGraphicalEditor (QString type)
Protected Attributes inherited from PhyMarXbot
QColor	colorv
bool	invisible
QString	namev
QString	texturev
wMatrix	tm
bool	usecolortextureofowner
World *	worldv

Detailed Description

The class modelling the marXbot robot.

This inherits from PhyMarXbot, so you can use all its methods

Definition at line 277 of file robots.h.

Constructor & Destructor Documentation

MarXbot	(	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 471 of file robots.cpp.

References PhyMarXbot::doKinematicSimulation(), PhyMarXbot::enableAttachmentDevice(), ConfigurationHelper::getBool(), PhyMarXbot::groundAroundIRSensorController(), PhyMarXbot::groundBottomIRSensorController(), PhyMarXbot::proximityIRSensorController(), RobotOnPlane::robotColor(), PhyMarXbot::setColor(), WheelMotorController::setEnabled(), IRSensorController::setEnabled(), PhyMarXbot::setGroundAroundIRSensorsGraphicalProperties(), PhyMarXbot::setGroundBottomIRSensorsGraphicalProperties(), PhyMarXbot::setProximityIRSensorsGraphicalProperties(), and PhyMarXbot::wheelsController().

~MarXbot ( )

virtual

Destructor.

Definition at line 538 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 506 of file robots.cpp.

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

bool isKinematic ( ) const

virtual

Returns true if the robot is in kinematic mode.

Returns

true if the robot is in kinematic mode

Implements RobotOnPlane.

Definition at line 579 of file robots.cpp.

References PhyMarXbot::isKinematic().

real orientation ( const Box2DWrapper *  plane ) const

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.

Implements RobotOnPlane.

Definition at line 563 of file robots.cpp.

References PhyBox::matrix(), PhyMarXbot::matrix(), and Box2DWrapper::phyObject().

Referenced by MarXbotSampledProximityIRSensor::update().

wVector position ( ) const

virtual

Returns the position of the robot.

Returns

the position of the robot

Implements RobotOnPlane.

Definition at line 548 of file robots.cpp.

References PhyMarXbot::matrix(), and wMatrix::w_pos.

Referenced by MarXbotSampledProximityIRSensor::update().

real robotHeight ( ) const

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

Implements RobotOnPlane.

Definition at line 569 of file robots.cpp.

References PhyMarXbot::basez, and PhyMarXbot::bodyh.

real robotRadius ( ) const

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

Implements RobotOnPlane.

Definition at line 574 of file robots.cpp.

References PhyMarXbot::bodyr.

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.

Reimplemented from RobotOnPlane.

Definition at line 501 of file robots.cpp.

References Logger::error().

void setOrientation ( const Box2DWrapper *  plane, real  angle  )

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

Implements RobotOnPlane.

Definition at line 553 of file robots.cpp.

References PhyMarXbot::matrix(), and PhyMarXbot::setMatrix().

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

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

Implements RobotOnPlane.

Definition at line 542 of file robots.cpp.

References PhyMarXbot::setPosition().

---

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

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