ArServerModeDockPatrolBot Class Reference

#include <ArServerClasses.h>

Inheritance diagram for ArServerModeDockPatrolBot:

List of all members.

---

Detailed Description

Docking class for the patrolbot.

Public Member Functions
virtual bool	isDocked (void)
	This should return true if the robot has power from the dock and false otherwise.
virtual void	enableDock (void)
	This should enable docking (turning on the charger or what not).
virtual void	disableDock (void)
	This should disable docking (turn off charger or what not).
virtual void	checkDock (void)
	Sees if the robot is already docked and activates itself if it is (subclass should implement).
virtual void	beforeDriveInCallback (void)
	This is a function that will be called before the robot drives in.
virtual void	afterDriveOutCallback (void)
	This is a function that will be called after the robot drives out.

---

Member Function Documentation

virtual void ArServerModeDockPatrolBot::afterDriveOutCallback (  void   )  [virtual]

This is a function that will be called after the robot drives out. This should do anything that needs to be done after the robot can drives out of the dock Reimplemented from ArServerModeDockTriangleBump.

virtual void ArServerModeDockPatrolBot::beforeDriveInCallback (  void   )  [virtual]

This is a function that will be called before the robot drives in. This should do anything that needs to be done before the robot can drive into the dock. Reimplemented from ArServerModeDockTriangleBump.

virtual void ArServerModeDockPatrolBot::disableDock (  void   )  [virtual]

This should disable docking (turn off charger or what not). This should disable docking (turn off charger or what not), it'll be called, this'll wait 5 seconds, and then the robot'll back away from the dock. Implements ArServerModeDockTriangleBump.

virtual void ArServerModeDockPatrolBot::enableDock (  void   )  [virtual]

This should enable docking (turning on the charger or what not). This should enable docking (turn on charger or what not), it'll be called after the robot bumps into the dock. After this the code'll wait a while for isDocked to become true. Implements ArServerModeDockTriangleBump.

---