ArServerModeWander Class Reference

#include <ArServerModeWander.h>

Inheritance diagram for ArServerModeWander:

List of all members.

Public Member Functions
virtual void	activate (void)
	The function called when the mode is activated, subclass must provide.
	ArServerModeWander (ArServerBase *server, ArRobot *robot)
virtual void	checkDefault (void)
	This will be called when there would be no other modes, if this mode wants to take over it should activate itself, if it doesn't want to take over it shouldn't activate.
virtual void	deactivate (void)
	The function called when the mode is deactivated, subclass must provide.
virtual ArActionGroup *	getActionGroup (void)
	This function should return the action group this mode uses.
void	netWander (ArServerClient *client, ArNetPacket *packet)
virtual void	userTask (void)
	The ArMode's user task, don't need one, subclass must provide if needed.
void	wander (void)
virtual	~ArServerModeWander ()
Protected Attributes
ArFunctor2C< ArServerModeWander, ArServerClient *, ArNetPacket * >	myNetWanderCB
ArActionGroupWander	myWanderGroup

---

Detailed Description

Examples:

drawingsExampleWithRobot.cpp, serverDemo.cpp, and simpleServerExample.cpp.

Definition at line 34 of file ArServerModeWander.h.

---

Constructor & Destructor Documentation

ArServerModeWander::ArServerModeWander (  ArServerBase *  server, ArRobot *  robot )

Definition at line 30 of file ArServerModeWander.cpp. References ArServerMode::addModeData(), and myNetWanderCB.

ArServerModeWander::~ArServerModeWander (   )  [virtual]

Definition at line 43 of file ArServerModeWander.cpp.

---

Member Function Documentation

void ArServerModeWander::activate (  void   )  [virtual]

The function called when the mode is activated, subclass must provide. Implements ArServerMode. Definition at line 48 of file ArServerModeWander.cpp. References ArActionGroup::activateExclusive(), ArServerMode::baseActivate(), ArRobot::clearDirectMotion(), myWanderGroup, and ArServerMode::setActivityTimeToNow(). Referenced by checkDefault(), and wander().

virtual void ArServerModeWander::checkDefault (  void   )  [inline, virtual]

This will be called when there would be no other modes, if this mode wants to take over it should activate itself, if it doesn't want to take over it shouldn't activate. Reimplemented from ArServerMode. Definition at line 44 of file ArServerModeWander.h. References activate().

void ArServerModeWander::deactivate (  void   )  [virtual]

The function called when the mode is deactivated, subclass must provide. Implements ArServerMode. Definition at line 59 of file ArServerModeWander.cpp. References ArServerMode::baseDeactivate(), ArActionGroup::deactivate(), and myWanderGroup.

virtual ArActionGroup* ArServerModeWander::getActionGroup (  void   )  [inline, virtual]

This function should return the action group this mode uses. Reimplemented from ArServerMode. Definition at line 45 of file ArServerModeWander.h. References myWanderGroup.

void ArServerModeWander::netWander (  ArServerClient *  client, ArNetPacket *  packet )

Definition at line 70 of file ArServerModeWander.cpp. References ArRobot::lock(), ArLog::log(), ArServerMode::setActivityTimeToNow(), ArRobot::unlock(), and wander().

void ArServerModeWander::userTask (  void   )  [virtual]

The ArMode's user task, don't need one, subclass must provide if needed. Reimplemented from ArServerMode. Definition at line 80 of file ArServerModeWander.cpp. References ArRobot::forceTryingToMove(), and ArServerMode::setActivityTimeToNow().

void ArServerModeWander::wander (  void   )

Definition at line 65 of file ArServerModeWander.cpp. References activate(). Referenced by netWander().

---

Member Data Documentation

ArFunctor2C<ArServerModeWander, ArServerClient *, ArNetPacket *> ArServerModeWander::myNetWanderCB [protected]

Definition at line 48 of file ArServerModeWander.h. Referenced by ArServerModeWander().

ArActionGroupWander ArServerModeWander::myWanderGroup [protected]

Definition at line 47 of file ArServerModeWander.h. Referenced by activate(), deactivate(), and getActionGroup().

---

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

• ArServerModeWander.h
• ArServerModeWander.cpp

---