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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, IWorldObject, ICompositeWorldObject, Event

Direct Known Subclasses:

AliveMessageCompositeImpl, AliveMessageMessage

public abstract class AliveMessage
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent, ICompositeWorldObject

Abstract definition of the GameBots2004 message ALIVE.

Complete message documentation: Synchronous message. Alive message are for confirmation, that the connection is still working. They are sent periodically with usual period of one second (this can change depending on the configuration of ControlServer)

Nested Class Summary

static class

AliveMessage.AliveMessageUpdate

Field Summary

static UnrealId	AliveMessageId
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime

Constructor Summary

AliveMessage()
Parameter-less contructor for the message.

Method Summary

UnrealId	getId() Returns an id of the object that is unique among all world objects.
long	getSimTime() Returns the simulation time when the event has occurred.
abstract double	getTime() Game time when this message was send.
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

Methods inherited from interface cz.cuni.amis.pogamut.multi.communication.worldview.object.ICompositeWorldObject

getLocal, getShared, getStatic

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

AliveMessageId

public static final UnrealId AliveMessageId

SimTime

protected long SimTime

Constructor Detail

AliveMessage

public AliveMessage()

Parameter-less contructor for the message.

Method Detail

getId

public UnrealId getId()

Description copied from interface: IWorldObject

Returns an id of the object that is unique among all world objects.

Specified by:

getId in interface IWorldObject

Returns:

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

Specified by:

getSimTime in interface IWorldObject

Returns:

timestamp

setSimTime

protected void setSimTime(long SimTime)

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

getTime

public abstract double getTime()

Game time when this message was send.

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()