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

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

All Implemented Interfaces:

IWorldObject, ISharedWorldObject, java.lang.Cloneable

Direct Known Subclasses:

AliveMessageMessage.AliveMessageSharedMessage, AliveMessageSharedImpl

public abstract class AliveMessageShared
extends InfoMessage
implements ISharedWorldObject

Abstract definition of the shared part 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)

Field Summary

static UnrealId	AliveMessageId
static java.util.Set<Token>	SharedPropertyTokens
protected long	SimTime

Constructor Summary

AliveMessageShared()
Parameter-less contructor for the message.

Method Summary

abstract AliveMessageShared	clone()
java.lang.Class	getCompositeClass()
UnrealId	getId() Returns an id of the object that is unique among all world objects.
long	getSimTime() Returns world time when the object was seen/updated for the last time.
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

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getProperties, getProperty

Field Detail

AliveMessageId

public static final UnrealId AliveMessageId

SimTime

protected long SimTime

SharedPropertyTokens

public static final java.util.Set<Token> SharedPropertyTokens

Constructor Detail

AliveMessageShared

public AliveMessageShared()

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: ISharedWorldObject

Returns world time when the object was seen/updated for the last time.

The time suppose to be growing as the simulation carries on.

Always should be actual_timestamp >= any_prevously_recorded_timestamp,

object1.getLastSeenTime() > object2.getLastSeenTime() means that object1 last seen after object2

Specified by:

getSimTime in interface IWorldObject

Specified by:

getSimTime in interface ISharedWorldObject

Returns:

setSimTime

protected void setSimTime(long SimTime)

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

clone

public abstract AliveMessageShared clone()

Specified by:

clone in interface ISharedWorldObject

Overrides:

clone in class java.lang.Object

getCompositeClass

public java.lang.Class getCompositeClass()

Specified by:

getCompositeClass in interface ISharedWorldObject

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()