cz.cuni.pogamut.Client
Class History

java.lang.Object
  cz.cuni.pogamut.Client.History

All Implemented Interfaces:

RcvMsgListener, java.util.EventListener

public class History
extends java.lang.Object
implements RcvMsgListener

History contains a structure which is a compound of couple containers it is an Array of Container of Set

• First level of indexation - TIME - using HistoryBatch as an item in array - see for reference
• Second level of indexation - TYPE
• Third levet - HashMap - key is ID, value Object

  example usage - getSeenMessageObjectsInTime(3,3) - return NavPoints(type = 3) that agent saw in last 3 end messages (last three batches)

  another example - getSeenMessageObjectsInTime(7,5) - return Players(type = 7) that agent saw in last 5 batches, but their properties will be same during the time, it doesn't matter that they moved before

  Field Summary

  private java.util.ArrayList<HistoryBatch>	batches
  private int	maxLenghtOfStoring
  private java.util.logging.Logger	platformLog

  Constructor Summary

  History(AgentBody body, java.util.logging.Logger logger)
  

  Method Summary

  void	addMessage(MessageObject newMsg) This method is synchronized!
  void	endMessage() creates new batch and puts it on the first position in messages (most recent) then copy all things from old batch (messages.get(1))...
  HistoryBatch	getFirstBatch()
  MessageObject	getFirstMessageOfType(MessageType type)
  int	getMaxLenghtOfStoring() get maximum number of stored HistoryBatches
  java.util.ArrayList<MessageObject>	getMessagesOfType(MessageType type)
  java.util.ArrayList<MessageObject>	getSeenMessageObjectsInTime(int time, MessageType type) gets NavPoints from now to specified time (number of batches) in the past NOTE: number of stored batches is limited, it takes a lot of disk space!
  HistoryIterator	iterator(int depth, MessageType type, boolean unique) returns HistoryIterator - entity, which could be used to search history for all objects of specified type up to specified depth unique indicates if you need only objects unique according to ID (for true) or all objects of type (for false), no matter that there will be more of one object - that could be useful for quessing opponent tactics or some other issues
  void	receiveMessage(RcvMsgEvent e) receiveMessage is a listener method that listens to AgentBody which receives messages from Parser and thus raise Event RcvMsgEvent there I distinguish end message from other messages!!!
  void	restartHistory() restarts history after the death of the agent
  void	setMaxLenghtOfStoring(int maxLenghtOfStoring) set max number of stored HistoryBatches
  java.lang.String	toString()

  Methods inherited from class java.lang.Object

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

  Field Detail

  batches

  private java.util.ArrayList<HistoryBatch> batches

  platformLog

  private java.util.logging.Logger platformLog

  maxLenghtOfStoring

  private int maxLenghtOfStoring

  Constructor Detail

  History

  public History(AgentBody body,
                 java.util.logging.Logger logger)

  Method Detail

  restartHistory

  public void restartHistory()

  restarts history after the death of the agent

  getMaxLenghtOfStoring

  public int getMaxLenghtOfStoring()

  get maximum number of stored HistoryBatches

  Returns:

  lenght of storing

  setMaxLenghtOfStoring

  public void setMaxLenghtOfStoring(int maxLenghtOfStoring)

  set max number of stored HistoryBatches

  Parameters:

  maxLenghtOfStoring -

  endMessage

  public void endMessage()

  creates new batch and puts it on the first position in messages (most recent)
  then copy all things from old batch (messages.get(1))...

  by copying is ment that it makes shallow copy every synchronous message (NAV, PLR, SLF, INV, etc.)
  hard copies are made when different object with same ID comes - Parser sends only different object with same ID, so it is cloned right after the update - hard copies stands only for synchronous messages

  addMessage

  public void addMessage(MessageObject newMsg)

  This method is synchronized!
  It is necessary to avoid data unconsistency when AgentBody thread adds items to messages and AgentMemory wants some information from messages

  Parameters:

  newMsg -

  receiveMessage

  public void receiveMessage(RcvMsgEvent e)

  receiveMessage is a listener method that listens to AgentBody which receives messages from Parser and thus raise Event RcvMsgEvent there I distinguish end message from other messages!!! any other specialy treated messages according to history should be solved here

  Specified by:

  receiveMessage in interface RcvMsgListener

  toString

  public java.lang.String toString()

  Overrides:

  toString in class java.lang.Object

  getFirstMessageOfType

  public MessageObject getFirstMessageOfType(MessageType type)

  Parameters:

  type -

  Returns:

  first object of specified type from all stored batches

  getFirstBatch

  public HistoryBatch getFirstBatch()

  Returns:

  first batch in the history that means recent batch

  getMessagesOfType

  public java.util.ArrayList<MessageObject> getMessagesOfType(MessageType type)

  Parameters:

  type -

  Returns:

  HashMap from the desired possition - the most recent

  getSeenMessageObjectsInTime

  public java.util.ArrayList<MessageObject> getSeenMessageObjectsInTime(int time,
                                                                        MessageType type)

  gets NavPoints from now to specified time (number of batches) in the past NOTE: number of stored batches is limited, it takes a lot of disk space!

  Parameters:

  type -

  time - - number of batches to the past

  Returns:

  seen objects of specified type in specified time (batches in past)

  iterator

  public HistoryIterator iterator(int depth,
                                  MessageType type,
                                  boolean unique)

  returns HistoryIterator - entity, which could be used to search history for all objects of specified type up to specified depth unique indicates if you need only objects unique according to ID (for true) or all objects of type (for false), no matter that there will be more of one object - that could be useful for quessing opponent tactics or some other issues

  Parameters:

  depth -

  type -

  unique -

  Returns:

  HistoryIterator