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, cz.cuni.amis.utils.listener.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

Fields

Modifier and Type	Field and Description
protected String	MessageId An Id matching the one sent by client.
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime

Constructor Summary

Constructors

Constructor and Description
PathListStart() Parameter-less contructor for the message.
PathListStart(PathListStart original) Cloning constructor from the full message.
PathListStart(String MessageId) Creates new instance of the message PathListStart.

Method Summary

Methods

Modifier and Type	Method and Description
String	getMessageId() An Id matching the one sent by client.
long	getSimTime() Simulation time in MILLI SECONDS !!!
protected void	setSimTime(long SimTime) Used by Yylex to slip correct time of the object or programmatically.
String	toHtmlString()
String	toJsonLiteral()
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 String PROTOTYPE

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

See Also:

Constant Field Values

SimTime

protected long SimTime

MessageId

protected 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(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()

Simulation time in MILLI SECONDS !!!

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

setSimTime

protected void setSimTime(long SimTime)

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

getMessageId

public String getMessageId()

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

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()

Overrides:

toJsonLiteral in class InfoMessage