Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

ArRobotParams Class Reference

Contains the robot parameters, according to the parameter file. More...

#include <ArRobotParams.h>

Inheritance diagram for ArRobotParams:

ArConfig List of all members.

Public Member Functions

 ArRobotParams ()
 Constructor.
int getAbsoluteMaxRotVelocity (void) const
 Returns the max rotational velocity of the robot.
int getAbsoluteMaxVelocity (void) const
 Returns the max velocity of the robot.
double getAngleConvFactor (void) const
 Returns the angle conversion factor.
const char * getClassName (void) const
 Returns the class from the parameter file.
double getDiffConvFactor (void) const
 Returns the wheel velocity difference to angular velocity conv factor.
double getDistConvFactor (void) const
 Returns the distance conversion factor.
double getGyroScaler (void) const
 Returns the multiplier for the Analog Gyro.
int getIRCycles (int number)
int getIRType (int number)
int getIRX (int number)
 Returns the X location of the given numbered IR.
int getIRY (int number)
 Returns the Y location of the given numbered IR.
bool getLaserFlipped (void) const
 If the laser is flipped on the robot.
const char * getLaserIgnore (void) const
 Gets the string that is the readings the sick should ignore.
const char * getLaserPort (void) const
 What port the laser is on.
bool getLaserPossessed (void) const
 Returns if the robot has a laser (according to param file).
bool getLaserPowerControlled (void) const
 If the laser power is controlled by the serial port lines.
double getLaserTh (void) const
 The rotation of the laser on the robot.
int getLaserX (void) const
 The X location of the laser.
int getLaserY (void) const
 The Y location of the laser.
int getNumIR (void) const
 Returns the number of IRs.
int getNumSonar (void) const
 Returns the number of sonar.
double getRangeConvFactor (void) const
 Returns the sonar range conversion factor.
bool getRequestEncoderPackets (void) const
 Returns true if encoder packets are automatically requested upon connection to the robot.
bool getRequestIOPackets (void) const
 Returns true if IO packets are automatically requested upon connection to the robot.
double getRobotDiagonal (void) const
 Returns the robot diagonal (half-height to diagonal of octagon).
double getRobotLength (void) const
 Returns the robot's length.
double getRobotRadius (void) const
 Returns the robot's radius.
double getRobotWidth (void) const
 Returns the robot's width.
int getRotAccel (void) const
 Gets the rot accel from param file (0 uses microcontroller param).
int getRotDecel (void) const
 Gets the rot decel from param file (0 uses microcontroller param).
int getRotVelMax (void) const
 Gets the max rot vel from param file (0 uses microcontroller param).
int getSonarTh (int number)
 Returns the heading of the given numbered sonar disc.
int getSonarX (int number)
 Returns the X location of the given numbered sonar disc.
int getSonarY (int number)
 Returns the Y location of the given numbered sonar disc.
const char * getSubClassName (void) const
 Returns the subclass from the parameter file.
int getSwitchToBaudRate (void)
 Returns the baud rate set in the param to talk to the robot at.
int getTransAccel (void) const
 Gets the trans accel from param file (0 uses microcontroller param).
int getTransDecel (void) const
 Gets the trans decel from param file (0 uses microcontroller param).
int getTransVelMax (void) const
 Gets the max trans vel from param file (0 uses microcontroller param).
double getVel2Divisor (void) const
 Returns the multiplier for VEL2 commands.
double getVelConvFactor (void) const
 Returns the velocity conversion factor.
bool hasMoveCommand (void) const
 Returns if the robot has a built in move command.
bool hasSettableAccsDecs (void) const
 Whether the accelerations and decelerations are settable or not.
bool hasSettableVelMaxes (void) const
 Gets whether the VelMax values are settable or not.
bool haveFrontBumpers (void) const
 Returns true if the robot has front bumpers.
bool haveIR (int number)
 Returns if the IR of the given number is valid.
bool haveNewTableSensingIR (void) const
 Returns true if the robot's table sensing IR bits are sent in the 4th-byte of the IO packet.
bool haveRearBumpers (void) const
 Returns true if the robot has rear bumpers.
bool haveSonar (int number)
 Returns if the sonar of the given number is valid.
bool haveTableSensingIR (void) const
 Returns true if the robot has table sensing IR.
bool isHolonomic (void) const
 Returns whether the robot is holonomic or not.
int numFrontBumpers (void) const
 Returns the number of front bumpers.
int numRearBumpers (void) const
 Returns the number of rear bumpers.
bool save (void)
 Saves it to the subtype.p in Aria::getDirectory/params.
virtual ~ArRobotParams ()
 Destructor.

Protected Types

enum  IRInfo { IR_X, IR_Y, IR_TYPE, IR_CYCLES }
enum  SonarInfo { SONAR_X, SONAR_Y, SONAR_TH }

Protected Member Functions

const std::list< ArArgumentBuilder * > * getIRUnits (void)
const std::list< ArArgumentBuilder * > * getSonarUnits (void)
void internalSetIR (int num, int type, int cycles, int x, int y)
void internalSetSonar (int num, int x, int y, int th)
bool parseIRUnit (ArArgumentBuilder *builder)
bool parseSonarUnit (ArArgumentBuilder *builder)

Protected Attributes

int myAbsoluteMaxRVelocity
int myAbsoluteMaxVelocity
double myAngleConvFactor
char myClass [1024]
double myDiffConvFactor
double myDistConvFactor
bool myFrontBumpers
std::list< ArArgumentBuilder * > myGetIRUnitList
std::list< ArArgumentBuilder * > myGetSonarUnitList
double myGyroScaler
bool myHaveMoveCommand
bool myHolonomic
std::map< int, std::map< int,
int > > 
myIRMap
ArRetFunctorC< const std::list<
ArArgumentBuilder * > *,
ArRobotParams
myIRUnitGetFunctor
ArRetFunctor1C< bool, ArRobotParams,
ArArgumentBuilder * > 
myIRUnitSetFunctor
bool myLaserFlipped
char myLaserIgnore [1024]
char myLaserPort [1024]
bool myLaserPossessed
bool myLaserPowerControlled
double myLaserTh
int myLaserX
int myLaserY
bool myNewTableSensingIR
int myNumFrontBumpers
int myNumIR
int myNumRearBumpers
int myNumSonar
double myRangeConvFactor
bool myRearBumpers
bool myRequestEncoderPackets
bool myRequestIOPackets
double myRobotDiagonal
double myRobotLength
double myRobotRadius
double myRobotWidth
int myRotAccel
int myRotDecel
int myRotVelMax
bool mySettableAccsDecs
bool mySettableVelMaxes
std::map< int, std::map< int,
int > > 
mySonarMap
ArRetFunctorC< const std::list<
ArArgumentBuilder * > *,
ArRobotParams
mySonarUnitGetFunctor
ArRetFunctor1C< bool, ArRobotParams,
ArArgumentBuilder * > 
mySonarUnitSetFunctor
char mySubClass [1024]
int mySwitchToBaudRate
bool myTableSensingIR
int myTransAccel
int myTransDecel
int myTransVelMax
double myVel2Divisor
double myVelConvFactor

Detailed Description

Contains the robot parameters, according to the parameter file.

Definition at line 34 of file ArRobotParams.h.


The documentation for this class was generated from the following files:
Generated on Wed Oct 19 12:56:54 2005 for Aria by  doxygen 1.4.0