cz.cuni.amis.pogamut.ut2004.agent.navigation

Interface IUT2004RunStraight

All Known Implementing Classes:

UT2004RunStraight

public interface IUT2004RunStraight

Interface for straight-runner that is combined with stuck-detectors.

Author:

Jimmy

Method Summary

Methods

Modifier and Type	Method and Description
void	addStuckDetector(IStuckDetector stuckDetector) Adds another stuck detector to be used for stuck detection :)
void	clearStuckDetectors() Removes ALL stuck detectors.
ILocated	getCurrentTarget() Get current target of the straight-run.
ILocated	getLastTarget() Get previous target of the straight-run.
boolean	isExecuting() Whether the object is executing the running.
boolean	isFailed() Whether our run has failed.
boolean	isSuccess() Whether our run has succeeded (once we get to our target, this returns true).
void	removeStuckDetector(IStuckDetector stuckDetector) Removes stuck detector.
void	runStraight(ILocated target) Run along straight-line to some target.
void	setFocus(ILocated focus) Sets focus of the bot when navigating (when using this object to run to some location target)! To reset focus call this method with null parameter.
void	stop(boolean stopMovement) Stop the running.

Method Detail

isExecuting

boolean isExecuting()

Whether the object is executing the running.

Returns:

isSuccess

boolean isSuccess()

Whether our run has succeeded (once we get to our target, this returns true).

Returns:

isFailed

boolean isFailed()

Whether our run has failed.

Returns:

getLastTarget

ILocated getLastTarget()

Get previous target of the straight-run.

Returns:

getCurrentTarget

ILocated getCurrentTarget()

Get current target of the straight-run.

Returns:

setFocus

void setFocus(ILocated focus)

Sets focus of the bot when navigating (when using this object to run to some location target)! To reset focus call this method with null parameter.

Parameters:

focus -

runStraight

void runStraight(ILocated target)

Run along straight-line to some target.

Parameters:

target -

stop

void stop(boolean stopMovement)

Stop the running.

addStuckDetector

void addStuckDetector(IStuckDetector stuckDetector)

Adds another stuck detector to be used for stuck detection :)

Parameters:

stuckDetector -

removeStuckDetector

void removeStuckDetector(IStuckDetector stuckDetector)

Removes stuck detector.

Parameters:

stuckDetector -

clearStuckDetectors

void clearStuckDetectors()

Removes ALL stuck detectors.