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

Class PathList

java.lang.Object

cz.cuni.amis.pogamut.base.communication.messages.InfoMessage

cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.PathList

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, cz.cuni.amis.utils.listener.Event

public class PathList
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event IPTH.

Complete message documentation: Info batch message. A series of pathnodes in response to a GETPATH command from the client. Starts with SPTH, ends with EPTH. Represents some path in the map (sequence of traversable navigation points).

Field Summary

Fields

Modifier and Type	Field and Description
protected Location	Location Location of one navigation point in the path.
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected UnrealId	RouteId Unique Id of one navigation point in the path (well it should be navigation point - safer is to use location).
protected long	SimTime

Constructor Summary

Constructors

Constructor and Description
PathList() Parameter-less contructor for the message.
PathList(PathList original) Cloning constructor from the full message.
PathList(UnrealId RouteId, Location Location) Creates new instance of the message PathList.

Method Summary

Methods

Modifier and Type	Method and Description
Location	getLocation() Location of one navigation point in the path.
UnrealId	getRouteId() Unique Id of one navigation point in the path (well it should be navigation point - safer is to use location).
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

RouteId

protected UnrealId RouteId

Unique Id of one navigation point in the path (well it should be navigation point - safer is to use location).

Location

protected Location Location

Location of one navigation point in the path.

Constructor Detail

PathList

public PathList()

Parameter-less contructor for the message.

PathList

public PathList(UnrealId RouteId,
        Location Location)

Creates new instance of the message PathList. Info batch message. A series of pathnodes in response to a GETPATH command from the client. Starts with SPTH, ends with EPTH. Represents some path in the map (sequence of traversable navigation points). Corresponding GameBots message is IPTH.

Parameters:

RouteId - Unique Id of one navigation point in the path (well it should be navigation point - safer is to use location).

Location - Location of one navigation point in the path.

PathList

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

getRouteId

public UnrealId getRouteId()

Unique Id of one navigation point in the path (well it should be navigation point - safer is to use location).

getLocation

public Location getLocation()

Location of one navigation point in the path.

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()

Overrides:

toJsonLiteral in class InfoMessage