SolutionRequest Class Reference

Manages runtime exhangeable modules. More...

#include <SolutionRequest.h>

List of all members.

Public Types
enum	ModuleID {   colorTableMod, sensorDataProcessor, imageProcessor,   ballLocator, teamBallLocator, obstaclesLocator,   playersLocator, selfLocator, robotStateDetector,   collisionDetector, behaviorControl, motionControl,   walkingEngineNormal, headControl, ledControl,   getupEngine, soundControl, sensorBehaviorControl,   numOfModules }
	Enumerator for exchange modules Add new exchangeable module here. More...
enum	ModuleSolutionID {   disabled = -1, colorTable32KMod = 0, colorTable64Mod,   colorTableTSLMod, numOfColorTableModSolutions, gt2004SelfLocator = 0,   odometrySelfLocator, specialPerceptSelfLocator, noOdometrySelfLocator,   numOfSelfLocatorSolutions, gt2004ImageProcessor = 0, checkerboardDetector,   rasterImageProcessor, numOfImageProcessorSolutions, gt2004BehaviorControlAgentSoccer = 0,   gt2004BehaviorControlAgentPenaltyShooter, gt2004BehaviorControlAgentJoystickControlled, gt2004BehaviorControlAgentOpenChallenge,   numOfBehaviorControlSolutions, gt2004CollisionDetector = 0, numOfCollisionDetectorSolutions,   gt2004WalkingEngine = 0, invKinMSH2004WalkingEngine, invKinBB2004WalkingEngine,   invKinUpsideDownWalkingEngine, invKinTurnWithBallWalkingEngine, invKinTurnKickWalkingEngine,   invKinERS7EvolveWalkingEngine, numOfWalkingEngineSolutions, gt2004BallLocator = 0,   numOfBallLocatorSolutions, gt2004TeamBallLocator = 0, numOfTeamBallLocatorSolutions,   gt2004PlayersLocator = 0, numOfPlayersLocatorSolutions, gt2004ObstaclesLocator = 0,   numOfObstaclesLocatorSolutions, gt2004HeadControl = 0, numOfHeadControlSolutions,   gt2004LEDControl = 0, numOfLEDControlSolutions, gt2004SensorDataProcessor = 0,   numOfSensorDataProcessorSolutions, gt2004RobotStateDetector = 0, numOfRobotStateDetectorSolutions,   obstacleAvoiderOnGreenField = 0, obstacleAvoiderOnGreenFieldERS7, motionrecognition,   simpleMotionRecognition, bb2004Calibrator, imageSaver,   numOfSensorBehaviorControlSolutions, gt2004MotionControl = 0, debugMotionControl,   numOfMotionControlSolutions, gt2004GetupEngine = 0, numOfGetupEngineSolutions,   gt2004SoundControl = 0, numOfSoundControlSolutions }
	enumerator for available solutions for all exchangeable modules Attention: add new solutions here dont forget to edit selector module too More...
enum	xabsl2EngineID {   gt2004, numOfXabslBehaviors, hc_gt2004 = numOfXabslBehaviors,   undefined }
	IDs for the module solutions using a Xabsl2Engine. More...
Public Member Functions
	SolutionRequest (bool setDefault=false)
	Constructor.
void	setDefaultSolutions ()
	Sets all modules to default solutions.
bool	operator== (const SolutionRequest &other)
	the == operator
bool	operator!= (const SolutionRequest &other)
	the == operator
Static Public Member Functions
const char *	getModuleName (ModuleID id)
	returns names for module ids Add new exchangeable module here
int	getNumOfSolutions (ModuleID id)
	Returns number of solutions in module id Attention: add new exchangeable module here.
const char *	getModuleSolutionName (ModuleID module, ModuleSolutionID solution)
	Returns names for module solution ids.
ModuleSolutionID	getDefaultSolution (ModuleID id)
	Returns default solution for module.
const char *	getXabsl2EngineIDName (xabsl2EngineID id)
	returns the name of a xabsl2EngineID
const char *	getXabsl2EngineFileID (xabsl2EngineID id)
	returns the beginning of the file name of a config file for a xabsl2Engine
Public Attributes
ModuleSolutionID	solutions [numOfModules]
	an array containing the selected solution for each module
bool	errorWhileReading
	ErrorWhileReading is set to true when an error occurred while reading the SolutionRequest eg when an module was missing or a solution was not recognized.

---

Detailed Description

Manages runtime exhangeable modules.

Definition at line 19 of file SolutionRequest.h.

---

Member Enumeration Documentation

enum SolutionRequest::ModuleID

Enumerator for exchange modules Add new exchangeable module here. Create new selector module for new exchangeable modules Enumeration values: colorTableMod  sensorDataProcessor  See class SensorDataProcessorSelector imageProcessor  See class ImageProcessorSelector ballLocator  See class BallLocatorSelector teamBallLocator  See class TeamBallLocatorSelector obstaclesLocator  See class ObstaclesLocatorSelector playersLocator  See class PlayersLocatorSelector selfLocator  See class SelfLocatorSelector robotStateDetector  See class RobotStateDetectorSelector collisionDetector  See class CollisionDetectorSelector behaviorControl  See class BehaviorControlSelector motionControl  See class MotionControlSelector walkingEngineNormal  See class WalkingEngineNormalSelector headControl  See class HeadControlSelector ledControl  See class LEDControlSelector getupEngine  See class GetupEngineSelector soundControl  See class SoundControlSelector sensorBehaviorControl  See class SensorBehaviorControlSelector numOfModules  Number of exchangeable modules Definition at line 27 of file SolutionRequest.h.

enum SolutionRequest::ModuleSolutionID

enumerator for available solutions for all exchangeable modules Attention: add new solutions here dont forget to edit selector module too Enumeration values: disabled  colorTable32KMod  colorTable64Mod  colorTableTSLMod  numOfColorTableModSolutions  gt2004SelfLocator  odometrySelfLocator  specialPerceptSelfLocator  noOdometrySelfLocator  numOfSelfLocatorSolutions  gt2004ImageProcessor  checkerboardDetector  rasterImageProcessor  numOfImageProcessorSolutions  gt2004BehaviorControlAgentSoccer  gt2004BehaviorControlAgentPenaltyShooter  gt2004BehaviorControlAgentJoystickControlled  gt2004BehaviorControlAgentOpenChallenge  numOfBehaviorControlSolutions  gt2004CollisionDetector  numOfCollisionDetectorSolutions  gt2004WalkingEngine  invKinMSH2004WalkingEngine  invKinBB2004WalkingEngine  invKinUpsideDownWalkingEngine  invKinTurnWithBallWalkingEngine  invKinTurnKickWalkingEngine  invKinERS7EvolveWalkingEngine  numOfWalkingEngineSolutions  gt2004BallLocator  numOfBallLocatorSolutions  gt2004TeamBallLocator  numOfTeamBallLocatorSolutions  gt2004PlayersLocator  numOfPlayersLocatorSolutions  gt2004ObstaclesLocator  numOfObstaclesLocatorSolutions  gt2004HeadControl  numOfHeadControlSolutions  gt2004LEDControl  numOfLEDControlSolutions  gt2004SensorDataProcessor  numOfSensorDataProcessorSolutions  gt2004RobotStateDetector  numOfRobotStateDetectorSolutions  obstacleAvoiderOnGreenField  obstacleAvoiderOnGreenFieldERS7  motionrecognition  simpleMotionRecognition  bb2004Calibrator  imageSaver  numOfSensorBehaviorControlSolutions  gt2004MotionControl  debugMotionControl  numOfMotionControlSolutions  gt2004GetupEngine  numOfGetupEngineSolutions  gt2004SoundControl  numOfSoundControlSolutions  Definition at line 54 of file SolutionRequest.h. Referenced by getDefaultSolution().

enum SolutionRequest::xabsl2EngineID

IDs for the module solutions using a Xabsl2Engine. Enumeration values: gt2004  numOfXabslBehaviors  hc_gt2004  undefined  Definition at line 363 of file SolutionRequest.h.

---

Constructor & Destructor Documentation

SolutionRequest::SolutionRequest (  bool  setDefault = false  )

Constructor. Parameters: setDefault  if true default modules will be selected else all modules are disabled Definition at line 16 of file SolutionRequest.cpp. References errorWhileReading, numOfModules, setDefaultSolutions(), and solutions.

Here is the call graph for this function:

---

Member Function Documentation

const char* SolutionRequest::getModuleName (  ModuleID  id  )  [inline, static]

returns names for module ids Add new exchangeable module here Definition at line 158 of file SolutionRequest.h. References colorTableMod, getupEngine, ledControl, and walkingEngineNormal. Referenced by operator<<().

int SolutionRequest::getNumOfSolutions (  ModuleID  id  )  [inline, static]

Returns number of solutions in module id Attention: add new exchangeable module here. Definition at line 188 of file SolutionRequest.h. References colorTableMod, getupEngine, ledControl, numOfBallLocatorSolutions, numOfBehaviorControlSolutions, numOfCollisionDetectorSolutions, numOfColorTableModSolutions, numOfGetupEngineSolutions, numOfHeadControlSolutions, numOfImageProcessorSolutions, numOfLEDControlSolutions, numOfMotionControlSolutions, numOfObstaclesLocatorSolutions, numOfPlayersLocatorSolutions, numOfRobotStateDetectorSolutions, numOfSelfLocatorSolutions, numOfSensorBehaviorControlSolutions, numOfSensorDataProcessorSolutions, numOfSoundControlSolutions, numOfTeamBallLocatorSolutions, numOfWalkingEngineSolutions, and walkingEngineNormal. Referenced by operator<<(), and operator>>().

const char* SolutionRequest::getModuleSolutionName (  ModuleID  module, ModuleSolutionID  solution )  [inline, static]

Returns names for module solution ids. Add new solutions here. Definition at line 219 of file SolutionRequest.h. References bb2004Calibrator, checkerboardDetector, colorTable32KMod, colorTable64Mod, colorTableMod, colorTableTSLMod, debugMotionControl, getupEngine, gt2004BallLocator, gt2004BehaviorControlAgentJoystickControlled, gt2004BehaviorControlAgentOpenChallenge, gt2004BehaviorControlAgentPenaltyShooter, gt2004BehaviorControlAgentSoccer, gt2004CollisionDetector, gt2004GetupEngine, gt2004HeadControl, gt2004ImageProcessor, gt2004LEDControl, gt2004MotionControl, gt2004ObstaclesLocator, gt2004PlayersLocator, gt2004RobotStateDetector, gt2004SelfLocator, gt2004SensorDataProcessor, gt2004SoundControl, gt2004TeamBallLocator, gt2004WalkingEngine, imageSaver, invKinBB2004WalkingEngine, invKinERS7EvolveWalkingEngine, invKinMSH2004WalkingEngine, invKinTurnKickWalkingEngine, invKinTurnWithBallWalkingEngine, invKinUpsideDownWalkingEngine, ledControl, motionrecognition, obstacleAvoiderOnGreenField, obstacleAvoiderOnGreenFieldERS7, odometrySelfLocator, rasterImageProcessor, simpleMotionRecognition, specialPerceptSelfLocator, and walkingEngineNormal. Referenced by operator<<().

ModuleSolutionID SolutionRequest::getDefaultSolution (  ModuleID  id  )  [inline, static]

Returns default solution for module. Definition at line 337 of file SolutionRequest.h. References ModuleSolutionID, and solutions. Referenced by ModuleSelector::ModuleSelector().

void SolutionRequest::setDefaultSolutions (   )

Sets all modules to default solutions. Definition at line 30 of file SolutionRequest.cpp. References InStream< InFile, InConfig >::eof(), errorWhileReading, InFile::exists(), getLocation(), numOfModules, and solutions. Referenced by SolutionRequest().

Here is the call graph for this function:

bool SolutionRequest::operator== (  const SolutionRequest &  other  )

the == operator Definition at line 48 of file SolutionRequest.cpp. References numOfModules, and solutions.

bool SolutionRequest::operator!= (  const SolutionRequest &  other  )  [inline]

the == operator Definition at line 352 of file SolutionRequest.h.

const char* SolutionRequest::getXabsl2EngineIDName (  xabsl2EngineID  id  )  [inline, static]

returns the name of a xabsl2EngineID Definition at line 372 of file SolutionRequest.h. References gt2004, and hc_gt2004.

const char* SolutionRequest::getXabsl2EngineFileID (  xabsl2EngineID  id  )  [inline, static]

returns the beginning of the file name of a config file for a xabsl2Engine Definition at line 385 of file SolutionRequest.h. References gt2004, and hc_gt2004.

---

Member Data Documentation

ModuleSolutionID SolutionRequest::solutions[numOfModules]

an array containing the selected solution for each module Definition at line 327 of file SolutionRequest.h. Referenced by getDefaultSolution(), operator<<(), operator==(), operator>>(), ModuleHandler::selectSolutions(), setDefaultSolutions(), and SolutionRequest().

bool SolutionRequest::errorWhileReading

ErrorWhileReading is set to true when an error occurred while reading the SolutionRequest eg when an module was missing or a solution was not recognized. Definition at line 360 of file SolutionRequest.h. Referenced by operator>>(), setDefaultSolutions(), and SolutionRequest().

---

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

• Tools/Module/SolutionRequest.h
• Tools/Module/SolutionRequest.cpp

---