The class modelling the marXbot robot. More...

Inheritance diagram for MarXbot:

List of all members.

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

The class modelling the marXbot robot.

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

Definition at line 121 of file robots.h.


Constructor & Destructor Documentation

MarXbot ( ConfigurationParameters params,
QString  prefix 
)

Constructor.

Parameters:
paramsthe configuration parameters object with parameters to use
prefixthe 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 ConfigurationHelper::getBool(), PhyMarXbot::groundAroundIRSensorController(), PhyMarXbot::groundBottomIRSensorController(), PhyMarXbot::proximityIRSensorController(), SensorController::setEnabled(), MotorController::setEnabled(), PhyMarXbot::setGroundAroundIRSensorsGraphicalProperties(), PhyMarXbot::setGroundBottomIRSensorsGraphicalProperties(), PhyMarXbot::setProximityIRSensorsGraphicalProperties(), and PhyMarXbot::wheelsController().

~MarXbot ( ) [virtual]

Destructor.

Definition at line 486 of file robots.cpp.


Member Function Documentation

void describe ( QString  type) [static]

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

Parameters:
typeis 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

Reimplemented from ParameterSettable.

Definition at line 463 of file robots.cpp.

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

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:
paramsthe configuration parameters object on which save actual parameters
prefixthe prefix to use to access the object configuration parameters.

Implements ParameterSettable.

Definition at line 458 of file robots.cpp.

References Logger::error().


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