ArServerModeIdle Class Reference

#include <ArServerModeIdle.h>

Inheritance diagram for ArServerModeIdle:

List of all members.

---

Detailed Description

Mode that the ArServerMode infrastructure will activate if someone tries to switch from one mode to another and there's idle processing to be done.

..

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.
	ArServerModeIdle (ArServerBase *server, ArRobot *robot)
	Constructor.
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.
ArServerMode *	getModeInterrupted (void)
	Gets the mode that this mode interrupted (or NULL if it didn't interrupt anything).
bool	getUseLocationDependentDevices (void)
	Gets whether we're using the range devices that depend on location.
void	setModeInterrupted (ArServerMode *modeInterrupted)
	Gets the mode that this mode interrupted (or NULL if none).
void	setUseLocationDependentDevices (bool useLocationDependentDevices, bool internal=false)
	Sets whether we're using the range devices that depend on location.
virtual void	userTask (void)
	The ArMode's user task, don't need one, subclass must provide if needed.
virtual	~ArServerModeIdle ()
	Destructor.
Protected Attributes
ArActionDeceleratingLimiter *	myLimiterBackward
ArActionDeceleratingLimiter *	myLimiterForward
ArActionDeceleratingLimiter *	myLimiterLateralLeft
ArActionDeceleratingLimiter *	myLimiterLateralRight
ArServerMode *	myModeInterrupted
ArFunctor2C< ArServerModeIdle, ArServerClient *, ArNetPacket * >	myNetIdleCB
ArActionGroupStop	myStopGroup
bool	myUseLocationDependentDevices

---

Constructor & Destructor Documentation

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

Constructor.

ArServerModeIdle::~ArServerModeIdle

(

)

[virtual]

Destructor.

---

Member Function Documentation

void ArServerModeIdle::activate

(

void

)

[virtual]

The function called when the mode is activated.

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

Implements ArServerMode.

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

Adds to the config.

void ArServerModeIdle::deactivate

(

void

)

[virtual]

The function called when the mode is deactivated.

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

Implements ArServerMode.

virtual ArActionGroup* ArServerModeIdle::getActionGroup

(

void

)

[inline, virtual]

This function should return the action group this mode uses.

Reimplemented from ArServerMode.

ArServerMode * ArServerModeIdle::getModeInterrupted

(

void

)

Gets the mode that this mode interrupted (or NULL if it didn't interrupt anything).

bool ArServerModeIdle::getUseLocationDependentDevices

(

void

)

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

void ArServerModeIdle::setModeInterrupted

(

ArServerMode *

modeInterrupted

)

Gets the mode that this mode interrupted (or NULL if none).

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

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

void ArServerModeIdle::userTask

(

void

)

[virtual]

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

Reimplemented from ArServerMode.

---

Member Data Documentation

ArActionDeceleratingLimiter* ArServerModeIdle::myLimiterBackward [protected]

ArActionDeceleratingLimiter* ArServerModeIdle::myLimiterForward [protected]

ArActionDeceleratingLimiter* ArServerModeIdle::myLimiterLateralLeft [protected]

ArActionDeceleratingLimiter* ArServerModeIdle::myLimiterLateralRight [protected]

ArServerMode* ArServerModeIdle::myModeInterrupted [protected]

ArFunctor2C<ArServerModeIdle, ArServerClient *, ArNetPacket *> ArServerModeIdle::myNetIdleCB [protected]

ArActionGroupStop ArServerModeIdle::myStopGroup [protected]

bool ArServerModeIdle::myUseLocationDependentDevices [protected]

---

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

• ArServerModeIdle.h
• ArServerModeIdle.cpp

---