kernel

Class SimulatorProxy

java.lang.Object

kernel.AbstractKernelComponent

kernel.SimulatorProxy

All Implemented Interfaces:

KernelComponent

public class SimulatorProxy
extends AbstractKernelComponent

This class is the kernel interface to a simulator.

Constructor Summary

Constructors

Constructor and Description
SimulatorProxy(java.lang.String name, int id, Connection c) Construct a new simulator.

Method Summary

Modifier and Type	Method and Description
ChangeSet	getUpdates(int time) Get updates from this simulator.
void	sendAgentCommands(int time, java.util.Collection<? extends Command> commands) Send a set of agent commands to this simulator.
void	sendUpdate(int time, ChangeSet update) Send an update message to this simulator.
void	setEntityIDGenerator(EntityIDGenerator generator) Set the EntityIDGenerator.
java.lang.String	toString()
protected void	updateReceived(int time, ChangeSet changes) Register an update from the simulator.

Methods inherited from class kernel.AbstractKernelComponent

getConnection, getName, send, send, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

SimulatorProxy

public SimulatorProxy(java.lang.String name,
                      int id,
                      Connection c)

Construct a new simulator.

Parameters:

name - The name of the simulator.

id - The ID of the simulator.

c - The connection this simulator is using.

Method Detail

getUpdates

public ChangeSet getUpdates(int time)
                     throws java.lang.InterruptedException

Get updates from this simulator. This method may block until updates are available.

Parameters:

time - The timestep to get updates for.

Returns:

A ChangeSet representing the updates from this simulator.

Throws:

java.lang.InterruptedException - If this thread is interrupted while waiting for updates.

sendUpdate

public void sendUpdate(int time,
                       ChangeSet update)

Send an update message to this simulator.

Parameters:

time - The simulation time.

update - The updated entities.

sendAgentCommands

public void sendAgentCommands(int time,
                              java.util.Collection<? extends Command> commands)

Send a set of agent commands to this simulator.

Parameters:

time - The current time.

commands - The agent commands to send.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setEntityIDGenerator

public void setEntityIDGenerator(EntityIDGenerator generator)

Set the EntityIDGenerator.

Parameters:

generator - The new EntityIDGenerator.

updateReceived

protected void updateReceived(int time,
                              ChangeSet changes)

Register an update from the simulator.

Parameters:

time - The timestep of the update.

changes - The set of changes.