rescuecore2.components

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

java.lang.Object

rescuecore2.components.AbstractComponent<T>

rescuecore2.components.AbstractViewer<T>

Type Parameters:

T - The subclass of WorldModel that this viewer understands.

All Implemented Interfaces:

Component, Viewer

Direct Known Subclasses:

StandardViewer

public abstract class AbstractViewer<T extends WorldModel<? extends Entity>>
extends AbstractComponent<T>
implements Viewer

Abstract base class for viewer implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	viewerID The ID of this viewer.

Fields inherited from class rescuecore2.components.AbstractComponent

config, connection, model, random

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	connect(Connection connection, RequestIDGenerator generator, Config config) Connect this component to the kernel.
int	getViewerID() Get this viewer's ID.
protected void	handleTimestep(KVTimestep timestep) Handle a KVTimestep object from the server.
void	postConnect(Connection c, int id, java.util.Collection<Entity> entities, Config kernelConfig) Notification that this viewer has been connected to the kernel.
protected void	processMessage(Message msg) Process an incoming message.

Methods inherited from class rescuecore2.components.AbstractComponent

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

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, shutdown

Field Detail

viewerID

protected int viewerID

The ID of this viewer.

Constructor Detail

AbstractViewer

protected AbstractViewer()

Create a new AbstractViewer.

Method Detail

getViewerID

public final int getViewerID()

Get this viewer's ID.

Returns:

The viewer ID.

postConnect

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

Description copied from interface: Viewer

Notification that this viewer has been connected to the kernel.

Specified by:

postConnect in interface Viewer

Parameters:

c - The connection to the kernel.

id - The ID of this viewer.

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

kernelConfig - The Config the kernel send to this agent 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.

handleTimestep

protected void handleTimestep(KVTimestep timestep)

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

Parameters:

timestep - The KVTimestep object.

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.