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

java.lang.Object
  extended by cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.AliveMessageLocal
All Implemented Interfaces:
IWorldObject, ILocalWorldObject, java.lang.Cloneable
Direct Known Subclasses:
AliveMessageLocalImpl, AliveMessageMessage.AliveMessageLocalMessage

public abstract class AliveMessageLocal
extends InfoMessage
implements ILocalWorldObject

Abstract definition of the local 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
           
protected  long SimTime
           
 
Constructor Summary
AliveMessageLocal()
          Parameter-less contructor for the message.
 
Method Summary
abstract  AliveMessageLocal clone()
           
 java.lang.Class getCompositeClass()
           
 UnrealId getId()
          Returns an id of the object that is unique among all world objects.
 AliveMessageLocal getLocal()
           
 ISharedWorldObject getShared()
           
 long getSimTime()
          Returns world time when the object was seen/updated for the last time.
 IStaticWorldObject getStatic()
           
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
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

AliveMessageId

public static final UnrealId AliveMessageId

SimTime

protected long SimTime
Constructor Detail

AliveMessageLocal

public AliveMessageLocal()
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: IWorldObject
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
Returns:

setSimTime

protected void setSimTime(long SimTime)
Used by Yylex to slip correct time of the object or programmatically.


clone

public abstract AliveMessageLocal clone()
Specified by:
clone in interface ILocalWorldObject
Overrides:
clone in class java.lang.Object

getCompositeClass

public java.lang.Class getCompositeClass()
Specified by:
getCompositeClass in interface ILocalWorldObject

getTime

public abstract double getTime()
Game time when this message was send.


getLocal

public AliveMessageLocal getLocal()

getShared

public ISharedWorldObject getShared()

getStatic

public IStaticWorldObject getStatic()

toString

public java.lang.String toString()
Overrides:
toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()