ArServerModeStop Class Reference

#include <ArServerModeStop.h>

Inheritance diagram for ArServerModeStop:

List of all members.

Public Member Functions
virtual void	activate (void)
	The function called when the mode is activated, subclass must provide.
	ArServerModeStop (ArServerBase *server, ArRobot *robot, bool defunct=false)
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	netStop (ArServerClient *client, ArNetPacket *packet)
void	stop (void)
virtual void	userTask (void)
	The ArMode's user task, don't need one, subclass must provide if needed.
virtual	~ArServerModeStop ()
Protected Attributes
ArFunctor2C< ArServerModeStop, ArServerClient *, ArNetPacket * >	myNetStopCB
ArActionGroupStop	myStopGroup

---

Detailed Description

Examples:

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

Definition at line 32 of file ArServerModeStop.h.

---

Constructor & Destructor Documentation

ArServerModeStop::ArServerModeStop (  ArServerBase *  server, ArRobot *  robot, bool  defunct = false )

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

ArServerModeStop::~ArServerModeStop (   )  [virtual]

Definition at line 45 of file ArServerModeStop.cpp.

---

Member Function Documentation

void ArServerModeStop::activate (  void   )  [virtual]

The function called when the mode is activated, subclass must provide. Implements ArServerMode. Definition at line 50 of file ArServerModeStop.cpp. References ArActionGroup::activateExclusive(), ArServerMode::baseActivate(), ArRobot::clearDirectMotion(), ArServerMode::isActive(), myStopGroup, and ArServerMode::setActivityTimeToNow(). Referenced by checkDefault(), main(), and stop().

virtual void ArServerModeStop::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 43 of file ArServerModeStop.h. References activate().

void ArServerModeStop::deactivate (  void   )  [virtual]

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

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

This function should return the action group this mode uses. Reimplemented from ArServerMode. Definition at line 44 of file ArServerModeStop.h. References myStopGroup.

void ArServerModeStop::netStop (  ArServerClient *  client, ArNetPacket *  packet )

Definition at line 71 of file ArServerModeStop.cpp. References ArRobot::lock(), ArLog::log(), ArServerMode::setActivityTimeToNow(), stop(), and ArRobot::unlock().

void ArServerModeStop::stop (  void   )

Definition at line 66 of file ArServerModeStop.cpp. References activate(). Referenced by netStop().

void ArServerModeStop::userTask (  void   )  [virtual]

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

---

Member Data Documentation

ArFunctor2C<ArServerModeStop, ArServerClient *, ArNetPacket *> ArServerModeStop::myNetStopCB [protected]

Definition at line 47 of file ArServerModeStop.h. Referenced by ArServerModeStop().

ArActionGroupStop ArServerModeStop::myStopGroup [protected]

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

---

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

• ArServerModeStop.h
• ArServerModeStop.cpp

---