rescuecore2.components

Class AbstractSimulator<T extends WorldModel<? extends Entity>>

java.lang.Object

rescuecore2.components.AbstractComponent<T>

rescuecore2.components.AbstractSimulator<T>

Type Parameters:

T - The subclass of WorldModel that this simulator understands.

All Implemented Interfaces:

Component, Simulator

Direct Known Subclasses:

SampleSimulator, StandardSimulator

public abstract class AbstractSimulator<T extends WorldModel<? extends Entity>>
extends AbstractComponent<T>
implements Simulator

Abstract base class for simulator implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	simulatorID The ID of this simulator.

Fields inherited from class rescuecore2.components.AbstractComponent

config, connection, model, random

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSimulator() Create a new AbstractSimulator.

Method Summary

Modifier and Type	Method and Description
void	connect(Connection connection, RequestIDGenerator generator, Config config) Connect this component to the kernel.
int	getSimulatorID() Get this simulator's ID.
protected void	handleCommands(KSCommands c) Handle a KSCommands object from the server.
protected void	handleUpdate(KSUpdate u) Handle a KSUpdate object from the server.
void	postConnect(Connection c, int id, java.util.Collection<Entity> entities, Config kernelConfig) Notification that this simulator has been connected to the kernel.
protected void	processCommands(KSCommands c, ChangeSet changes) Process the commands from the server and populate a ChangeSet.
protected boolean	processImmediately(Message msg) Process an incoming message immediately.
protected void	processMessage(Message msg) Process an incoming message.
protected java.util.List<EntityID>	requestNewEntityIDs(int count) Request some new entity IDs from the kernel.
void	shutdown() Shut this component down.

Methods inherited from class rescuecore2.components.AbstractComponent

createWorldModel, getName, getPreferredLogContext, getPreferredNDC, getPreferredRegistry, initialise, postConnect, postConnect, send

Methods inherited from class java.lang.Object

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

Methods inherited from interface rescuecore2.components.Component

getName, getPreferredLogContext, getPreferredRegistry, initialise

Field Detail

simulatorID

protected int simulatorID

The ID of this simulator.

Constructor Detail

AbstractSimulator

protected AbstractSimulator()

Create a new AbstractSimulator.

Method Detail

getSimulatorID

public final int getSimulatorID()

Get this simulator's ID.

Returns:

The simulator ID.

postConnect

public void postConnect(Connection c,
                        int id,
                        java.util.Collection<Entity> entities,
                        Config kernelConfig)

Description copied from interface: Simulator

Notification that this simulator has been connected to the kernel.

Specified by:

postConnect in interface Simulator

Parameters:

c - The connection to the kernel.

id - The ID of this simulator.

entities - The set of Entities the kernel sent to this simulator on connection.

kernelConfig - The Config the kernel send to this simulator on connection.

connect

public void connect(Connection connection,
                    RequestIDGenerator generator,
                    Config config)
             throws ConnectionException,
                    ComponentConnectionException,
                    java.lang.InterruptedException

Description copied from interface: Component

Connect this component to the kernel.

Specified by:

connect in interface Component

Parameters:

connection - The Connection to use.

generator - The RequestIDGenerator to use.

config - The system configuration.

Throws:

ConnectionException - If there is a problem communicating with the kernel.

ComponentConnectionException - If the connection fails.

java.lang.InterruptedException - If the thread is interrupted before the connection attempt completes.

shutdown

public void shutdown()

Description copied from interface: Component

Shut this component down.

Specified by:

shutdown in interface Component

Overrides:

shutdown in class AbstractComponent<T extends WorldModel<? extends Entity>>

handleUpdate

protected void handleUpdate(KSUpdate u)

Handle a KSUpdate object from the server. The default implementation just updates the world model.

Parameters:

u - The Update object.

handleCommands

protected void handleCommands(KSCommands c)

Handle a KSCommands object from the server. The default implementation tells the kernel that nothing has changed.

Parameters:

c - The Commands object.

processCommands

protected void processCommands(KSCommands c,
                               ChangeSet changes)

Process the commands from the server and populate a ChangeSet.

Parameters:

c - The commands to process.

changes - The ChangeSet to populate.

requestNewEntityIDs

protected java.util.List<EntityID> requestNewEntityIDs(int count)
                                                throws java.lang.InterruptedException

Request some new entity IDs from the kernel.

Parameters:

count - The number to request.

Returns:

A list of new entity IDs.

Throws:

java.lang.InterruptedException

processMessage

protected void processMessage(Message msg)

Description copied from class: AbstractComponent

Process an incoming message.

Overrides:

processMessage in class AbstractComponent<T extends WorldModel<? extends Entity>>

Parameters:

msg - The incoming message.

processImmediately

protected boolean processImmediately(Message msg)

Description copied from class: AbstractComponent

Process an incoming message immediately. If the message can be processed quickly then this method should do so and return true. If the message may take some time to process (e.g. if it is a sense message (for agents) or a command message (for simulators) then this method should return false and the message will be processed in a different thread via the AbstractComponent.processMessage(Message) method.

Overrides:

processImmediately in class AbstractComponent<T extends WorldModel<? extends Entity>>

Parameters:

msg - The incoming message.

Returns:

true If the message was processed immediately, false if it requires slower processing.