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

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

All Implemented Interfaces:

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

public class EndMessage
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event END.

Complete message documentation: Synchronous message. This message signalizes end of synchronous batch.

Field Summary

static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime
protected double	Time Time, when the message was sent - intern UT time.
protected boolean	VisUpdate Sent only if new synchronous batch procotol is used (NewSelfBatchProtocol attribute in INIT message).

Constructor Summary

EndMessage()
Parameter-less contructor for the message.

EndMessage(double Time, boolean VisUpdate)
Creates new instance of the message EndMessage.

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

Method Summary

long	getSimTime() Simulation time in MILLI SECONDS !!!
double	getTime() Time, when the message was sent - intern UT time.
boolean	isVisUpdate() Sent only if new synchronous batch procotol is used (NewSelfBatchProtocol attribute in INIT message).
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

Time

protected double Time

Time, when the message was sent - intern UT time.

VisUpdate

protected boolean VisUpdate

Sent only if new synchronous batch procotol is used (NewSelfBatchProtocol attribute in INIT message). If true it means this sync. batches contains also visiblity information - PLR, INV, PRJ messages... If false, it means that only SELF message is in this synchronous batch.

Constructor Detail

EndMessage

public EndMessage()

Parameter-less contructor for the message.

EndMessage

public EndMessage(double Time,
                  boolean VisUpdate)

Creates new instance of the message EndMessage. Synchronous message. This message signalizes end of synchronous batch. Corresponding GameBots message is END.

Parameters:

Time - Time, when the message was sent - intern UT time.

VisUpdate - Sent only if new synchronous batch procotol is used (NewSelfBatchProtocol attribute in INIT message). If true it means this sync. batches contains also visiblity information - PLR, INV, PRJ messages... If false, it means that only SELF message is in this synchronous batch.

EndMessage

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

getTime

public double getTime()

Time, when the message was sent - intern UT time.

isVisUpdate

public boolean isVisUpdate()

Sent only if new synchronous batch procotol is used (NewSelfBatchProtocol attribute in INIT message). If true it means this sync. batches contains also visiblity information - PLR, INV, PRJ messages... If false, it means that only SELF message is in this synchronous batch.

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()

Overrides:

toJsonLiteral in class InfoMessage