cz.cuni.amis.pogamut.base.agent.navigation

Interface IStuckDetector

public interface IStuckDetector

Stuck detector provides a functionality to detect the situation in which the bot is unable to reach its destination. Stuck detector does that (usually) based on some heuristics.

Author:

Jimmy

Method Summary

Modifier and Type	Method and Description
String	getStuckDetails() Returns human-readable string describing why the bot has stuck.
boolean	isStuck() Tells whether the detector has detected a stuck.
void	reset() Restarts the detector - this method is called just before the executor starts to follow the path.
void	setBotTarget(ILocated target) Where the bot is currently trying to get with DIRECT MOVEMENT (possibly with JUMPS).
void	setBotWaiting(boolean state) Tells the stuck detector, that the bot is waiting for something, thus the detector should not detect stuck!
void	setEnabled(boolean state) Enable / Disable stuck detector.

Method Detail

setEnabled

void setEnabled(boolean state)

Enable / Disable stuck detector. Default: FALSE (== disabled)

setBotWaiting

void setBotWaiting(boolean state)

Tells the stuck detector, that the bot is waiting for something, thus the detector should not detect stuck!

Parameters:

state -

setBotTarget

void setBotTarget(ILocated target)

Where the bot is currently trying to get with DIRECT MOVEMENT (possibly with JUMPS).

Parameters:

target -

isStuck

boolean isStuck()

Tells whether the detector has detected a stuck.

Returns:

getStuckDetails

String getStuckDetails()

Returns human-readable string describing why the bot has stuck. Must be non-null whenever isStuck(), otherwise may contain null or arbitrary meaningless string.

Returns:

reset

void reset()

Restarts the detector - this method is called just before the executor starts to follow the path.

If isStuck() was reporting true, it should report 'false' after the reset (until next stuck is detected).