Module Class Reference

Base class for all modules. More...

#include <Module.h>

Inheritance diagram for Module:

[legend]Collaboration diagram for Module:

[legend]List of all members.

Public Member Functions
virtual void	execute ()=0
	executes the module
virtual bool	handleMessage (InMessage &message)
	Called from a MessageQueue to distribute messages.
virtual	~Module ()

---

Detailed Description

Base class for all modules.

Author:

Matthias Jüngel

Martin Lötzsch

Definition at line 23 of file Module.h.

---

Constructor & Destructor Documentation

virtual Module::~Module (   )  [inline, virtual]

Definition at line 39 of file Module.h.

---

Member Function Documentation

virtual void Module::execute (   )  [pure virtual]

executes the module Implemented in GT2004BallLocator, GT2004BehaviorControl, Xabsl2BehaviorControlAgentInterface, GT2004CollisionDetector, ColorTable32KMod, ColorTable64Mod, ColorTableTSLMod, GetupEngine, GT2004HeadControl, Xabsl2HeadControlAgentInterface, CheckerboardDetector, GT2004ImageProcessor, RasterImageProcessor, GT2004LEDControl, DebugMotionControl, GT2004MotionControl, GT2004ObstaclesLocator, GT2004PlayersLocator, GT2004RobotStateDetector, GT2004SelfLocator, NoOdometrySelfLocator, OdometrySelfLocator, SpecialPerceptSelfLocator, BB2004Calibrator, ImageSaver, MotionRecognition, ObstacleAvoiderOnGreenField, ObstacleAvoiderOnGreenFieldERS7, SimpleMotionRecognition, GT2004SensorDataProcessor, GT2004SoundControl, SpecialActions, AutoShutter, BarCodeReader, ChallengeSpecialVision, DefaultSpecialVision, GT2004TeamBallLocator, and WalkingEngine. Referenced by ModuleSelector::execute(), and Cognition::main().

virtual bool Module::handleMessage (  InMessage &  message  )  [inline, virtual]

Called from a MessageQueue to distribute messages. Use message.getMessageID to decide if the message is relavant for the MesssageHandler derivate. Use message.bin, message.text or message.config as In streams to get the data from. Parameters: message  The message that can be read. Returns: true if the message was read (handled). Implements MessageHandler. Reimplemented in GT2004BallLocator, GT2004BehaviorControl, Xabsl2BehaviorControl, Xabsl2BehaviorControlAgentInterface, GT2004HeadControl, Xabsl2HeadControl, Xabsl2HeadControlAgentInterface, GT2004ImageProcessor, RasterImageProcessor, DebugMotionControl, GT2004MotionControl, GT2004ObstaclesLocator, GT2004SelfLocator, NoOdometrySelfLocator, BB2004Calibrator, ImageSaver, MotionRecognition, ObstacleAvoiderOnGreenField, ObstacleAvoiderOnGreenFieldERS7, SimpleMotionRecognition, GT2003MotionNetSpecialActions, BB2004InvKinWalkingEngine, GT2004WalkingEngine, InvKinWalkingEngine, ParamInvKinWalkingEngine, ParamRearOnlyInvKinWalkingEngine, MSH2004InvKinWalkingEngine, and WalkingEngineSelector. Definition at line 37 of file Module.h. Referenced by ModuleSelector::handleMessage(), and GT2004MotionControl::handleMessage().

---

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

• Tools/Module/Module.h

---