ArServerModeStop Class Reference

#include <ArServerModeStop.h>

Inheritance diagram for ArServerModeStop:

List of all members.

---

Detailed Description

Examples:

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

Public Member Functions
virtual void	activate (void)
	The function called when the mode is activated.
void	addToConfig (ArConfig *config, const char *section="Teleop settings")
	Adds to the config.
	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.
virtual ArActionGroup *	getActionGroup (void)
	This function should return the action group this mode uses.
bool	getUseLocationDependentDevices (void)
	Gets whether we're using the range devices that depend on location.
void	netStop (ArServerClient *client, ArNetPacket *packet)
void	setUseLocationDependentDevices (bool useLocationDependentDevices, bool internal=false)
	Sets whether we're using the range devices that depend on location.
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
ArActionDeceleratingLimiter *	myLimiterBackward
ArActionDeceleratingLimiter *	myLimiterForward
ArActionDeceleratingLimiter *	myLimiterLateralLeft
ArActionDeceleratingLimiter *	myLimiterLateralRight
ArFunctor2C< ArServerModeStop, ArServerClient *, ArNetPacket * >	myNetStopCB
ArActionGroupStop	myStopGroup
bool	myUseLocationDependentDevices

---

Constructor & Destructor Documentation

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

ArServerModeStop::~ArServerModeStop

(

)

[virtual]

---

Member Function Documentation

void ArServerModeStop::activate

(

void

)

[virtual]

The function called when the mode is activated.

Subclasses must implement this, but also call baseActivate().-

Implements ArServerMode.

Examples:

serverDemo.cpp.

void ArServerModeStop::addToConfig	(	ArConfig *	config,
		const char *	section = "Teleop settings"
	)

Adds to the config.

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.

void ArServerModeStop::deactivate

(

void

)

[virtual]

The function called when the mode is deactivated.

Subclasses must implement this, and also call baseDeactivate().

Implements ArServerMode.

virtual ArActionGroup* ArServerModeStop::getActionGroup

(

void

)

[inline, virtual]

This function should return the action group this mode uses.

Reimplemented from ArServerMode.

bool ArServerModeStop::getUseLocationDependentDevices

(

void

)

Gets whether we're using the range devices that depend on location.

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

void ArServerModeStop::setUseLocationDependentDevices	(	bool	useLocationDependentDevices,
		bool	internal = false
	)

Sets whether we're using the range devices that depend on location.

void ArServerModeStop::stop

(

void

)

void ArServerModeStop::userTask

(

void

)

[virtual]

The ArMode's user task, don't need one, subclass must provide if needed.

Reimplemented from ArServerMode.

---

Member Data Documentation

ArActionDeceleratingLimiter* ArServerModeStop::myLimiterBackward [protected]

ArActionDeceleratingLimiter* ArServerModeStop::myLimiterForward [protected]

ArActionDeceleratingLimiter* ArServerModeStop::myLimiterLateralLeft [protected]

ArActionDeceleratingLimiter* ArServerModeStop::myLimiterLateralRight [protected]

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

ArActionGroupStop ArServerModeStop::myStopGroup [protected]

bool ArServerModeStop::myUseLocationDependentDevices [protected]

---

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

• ArServerModeStop.h
• ArServerModeStop.cpp

---