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

Package class diagram package LocationUpdate
java.lang.Object
  extended by cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.LocationUpdate
All Implemented Interfaces:
IWorldChangeEvent, IWorldEvent, IWorldObject, ICompositeWorldObject, cz.cuni.amis.utils.listener.Event
Direct Known Subclasses:
LocationUpdateCompositeImpl, LocationUpdateMessage

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

Abstract definition of the GameBots2004 message UPD.

Complete message documentation: "Synchronous" message. Arrives outside sync. batch. The frequency of this message is configured through locUpdateMultiplier variable in GameBots2004.ini file. It gets exported N times faster than regular sync. batch where N equals locUpdateMultiplier. Holds information about Location, Velocity and Rotation of the bot and should help us to create more robust navigation.


Nested Class Summary
static class LocationUpdate.LocationUpdateUpdate
           
 
Field Summary
static String PROTOTYPE
          Example how the message looks like - used during parser tests.
protected  long SimTime
           
 
Constructor Summary
LocationUpdate()
          Parameter-less contructor for the message.
 
Method Summary
abstract  UnrealId getId()
          Unique Id of this update message instance.
abstract  Location getLoc()
          An absolute location of the bot.
abstract  Rotation getRot()
          Which direction the bot is facing in absolute terms.
 long getSimTime()
          Simulation time in MILLI SECONDS !!!
abstract  Velocity getVel()
          Absolute velocity of the bot as a vector of movement per one game second.
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
 
Methods inherited from interface cz.cuni.amis.pogamut.multi.communication.worldview.object.ICompositeWorldObject
getLocal, getShared, getStatic
 

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
Constructor Detail

LocationUpdate

public LocationUpdate()
Parameter-less contructor for the message.

Method Detail

getSimTime

public long getSimTime()
Simulation time in MILLI SECONDS !!!

Specified by:
getSimTime in interface IWorldChangeEvent
Specified by:
getSimTime in interface IWorldEvent
Specified by:
getSimTime in interface IWorldObject

setSimTime

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


getId

public abstract UnrealId getId()
Unique Id of this update message instance.

Specified by:
getId in interface IWorldObject

getLoc

public abstract Location getLoc()
An absolute location of the bot.


getVel

public abstract Velocity getVel()
Absolute velocity of the bot as a vector of movement per one game second.


getRot

public abstract Rotation getRot()
Which direction the bot is facing in absolute terms.


toString

public String toString()
Overrides:
toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()
Overrides:
toJsonLiteral in class InfoMessage


Copyright © 2014 AMIS research group, Faculty of Mathematics and Physics, Charles University in Prague, Czech Republic. All Rights Reserved.