rescuecore2

Class Timestep

java.lang.Object

rescuecore2.Timestep

public class Timestep
extends java.lang.Object

A record of everything that happened in a timestep. This includes agent perception, commands and world model updates.

Constructor Summary

Constructors

Constructor and Description
Timestep(int time) Construct a timestep record.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Command>	getAgentHearing(EntityID agentID) Get the communication messages that an agent heard at the start of this timestep.
ChangeSet	getAgentPerception(EntityID agentID) Get the changes to entities that an agent saw at the start of this timestep.
java.util.Set<EntityID>	getAgentsWithUpdates() Get the set of agent IDs for agents that received an update this timestep.
ChangeSet	getChangeSet() Get the changes to entities during this timestep.
java.util.Collection<Command>	getCommands() Get the commands sent by agents this timestep.
java.util.Collection<Command>	getCommands(EntityID agentID) Get the commands sent by a particular agent this timestep.
double	getScore() Get the score for this timestep.
int	getTime() Get the time.
void	registerPerception(EntityID id, ChangeSet perception, java.util.Collection<Command> hearing) Register agent perception.
void	setChangeSet(ChangeSet c) Set the simulator updates ChangeSet for this timestep.
void	setCommands(java.util.Collection<Command> c) Set the commands for this timestep.
void	setScore(double s) Set the score for this timestep.

Methods inherited from class java.lang.Object

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

Constructor Detail

Timestep

public Timestep(int time)

Construct a timestep record.

Parameters:

time - The timestep number.

Method Detail

setCommands

public void setCommands(java.util.Collection<Command> c)

Set the commands for this timestep.

Parameters:

c - The commands.

setChangeSet

public void setChangeSet(ChangeSet c)

Set the simulator updates ChangeSet for this timestep.

Parameters:

c - The ChangeSet.

registerPerception

public void registerPerception(EntityID id,
                               ChangeSet perception,
                               java.util.Collection<Command> hearing)

Register agent perception.

Parameters:

id - The agent ID.

perception - The ChangeSet the entity can perceive.

hearing - The messages the agent heard.

setScore

public void setScore(double s)

Set the score for this timestep.

Parameters:

s - The score.

getTime

public int getTime()

Get the time.

Returns:

The time.

getCommands

public java.util.Collection<Command> getCommands()

Get the commands sent by agents this timestep.

Returns:

The commands.

getCommands

public java.util.Collection<Command> getCommands(EntityID agentID)

Get the commands sent by a particular agent this timestep.

Parameters:

agentID - The ID of the agent.

Returns:

All commands send by that agent.

getChangeSet

public ChangeSet getChangeSet()

Get the changes to entities during this timestep.

Returns:

The changes.

getAgentsWithUpdates

public java.util.Set<EntityID> getAgentsWithUpdates()

Get the set of agent IDs for agents that received an update this timestep.

Returns:

The IDs of all agents that received an update.

getAgentPerception

public ChangeSet getAgentPerception(EntityID agentID)

Get the changes to entities that an agent saw at the start of this timestep.

Parameters:

agentID - The agent ID to look up.

Returns:

The ChangeSet the agent saw, or null if the ID is not recognised.

getAgentHearing

public java.util.Collection<Command> getAgentHearing(EntityID agentID)

Get the communication messages that an agent heard at the start of this timestep.

Parameters:

agentID - The agent ID to look up.

Returns:

The set of messages the agent heard, or null if the ID is not recognised.

getScore

public double getScore()

Get the score for this timestep.

Returns:

The score.