cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages
Class Reachable

java.lang.Object
  cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.Reachable

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, Event

public class Reachable
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event RCH.

Complete message documentation: Asynchronous message. A boolean result of a checkreach call.

Field Summary

protected Location	From Exact location of bot at time of check.
protected java.lang.String	Id An Id matching the one sent by client.
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected boolean	Reachable True if the bot can run here directly, false otherwise.
protected long	SimTime

Constructor Summary

Reachable()
Parameter-less contructor for the message.

Reachable(Reachable original)
Cloning constructor from the full message.

Reachable(java.lang.String Id, boolean Reachable, Location From)
Creates new instance of the message Reachable.

Method Summary

Location	getFrom() Exact location of bot at time of check.
java.lang.String	getId() An Id matching the one sent by client.
long	getSimTime() Returns the simulation time when the event has occurred.
boolean	isReachable() True if the bot can run here directly, false otherwise.
protected void	setSimTime(long SimTime) Used by Yylex to slip correct time of the object or programmatically.
java.lang.String	toHtmlString()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROTOTYPE

public static final java.lang.String PROTOTYPE

Example how the message looks like - used during parser tests.

See Also:

Constant Field Values

SimTime

protected long SimTime

Id

protected java.lang.String Id

An Id matching the one sent by client. Allows bot to match answer with right querry.

Reachable

protected boolean Reachable

True if the bot can run here directly, false otherwise.

From

protected Location From

Exact location of bot at time of check.

Constructor Detail

Reachable

public Reachable()

Parameter-less contructor for the message.

Reachable

public Reachable(java.lang.String Id,
                 boolean Reachable,
                 Location From)

Creates new instance of the message Reachable. Asynchronous message. A boolean result of a checkreach call. Corresponding GameBots message is RCH.

Parameters:

Id - An Id matching the one sent by client. Allows bot to match answer with right querry.

Reachable - True if the bot can run here directly, false otherwise.

From - Exact location of bot at time of check.

Reachable

public Reachable(Reachable original)

Cloning constructor from the full message.

Parameters:

original -

Method Detail

getSimTime

public long getSimTime()

Description copied from interface: IWorldEvent

Returns the simulation time when the event has occurred.

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

Returns:

timestamp

setSimTime

protected void setSimTime(long SimTime)

Used by Yylex to slip correct time of the object or programmatically.

getId

public java.lang.String getId()

An Id matching the one sent by client. Allows bot to match answer with right querry.

isReachable

public boolean isReachable()

True if the bot can run here directly, false otherwise.

getFrom

public Location getFrom()

Exact location of bot at time of check.

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()