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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, Event

public class PathListStart
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event SPTH.

Complete message documentation: Start of the path list sent as an response to GETPATH command (IPTH messages).

Field Summary

protected java.lang.String	MessageId An Id matching the one sent by client.
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime

Constructor Summary

PathListStart()
Parameter-less contructor for the message.

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

PathListStart(java.lang.String MessageId)
Creates new instance of the message PathListStart.

Method Summary

java.lang.String	getMessageId() An Id matching the one sent by client.
long	getSimTime() Returns the simulation time when the event has occurred.
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

MessageId

protected java.lang.String MessageId

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

Constructor Detail

PathListStart

public PathListStart()

Parameter-less contructor for the message.

PathListStart

public PathListStart(java.lang.String MessageId)

Creates new instance of the message PathListStart. Start of the path list sent as an response to GETPATH command (IPTH messages). Corresponding GameBots message is SPTH.

Parameters:

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

PathListStart

public PathListStart(PathListStart 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.

getMessageId

public java.lang.String getMessageId()

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

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()