rescuecore2.components

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

java.lang.Object

rescuecore2.components.AbstractComponent<T>

Type Parameters:

T - The subclass of WorldModel that this component understands.

All Implemented Interfaces:

Component

Direct Known Subclasses:

AbstractAgent, AbstractSimulator, AbstractViewer

public abstract class AbstractComponent<T extends WorldModel<? extends Entity>>
extends java.lang.Object
implements Component

Abstract base class for component implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected Config	config The configuration.
protected Connection	connection The connection to the kernel.
protected T	model The world model.
protected java.util.Random	random A random number generator.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected abstract T	createWorldModel() Construct the world model.
java.lang.String	getName() Get the name of this component.
java.lang.String	getPreferredLogContext() Get the preferred log context for this component.
protected java.lang.String	getPreferredNDC() Get the preferred nested diagnostic context to use when processing messages for this component.
Registry	getPreferredRegistry(Registry parent) Get the registry this component would like to use for its connection.
void	initialise() Initialise this component before connection.
protected void	postConnect() Perform any post-connection work required before acknowledgement of the connection is made.
protected void	postConnect(Connection c, java.util.Collection<Entity> entities, Config kernelConfig) Notification that connection to the kernel succeeded.
protected boolean	processImmediately(Message msg) Process an incoming message immediately.
protected void	processMessage(Message msg) Process an incoming message.
protected void	send(Message msg) Send a message to the kernel and silently ignore any errors.
void	shutdown() Shut this component down.

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

connect

Field Detail

connection

protected Connection connection

The connection to the kernel.

config

protected Config config

The configuration. This will be automatically updated by the postConnect method to include config information from the kernel.

model

protected T extends WorldModel<? extends Entity> model

The world model.

random

protected java.util.Random random

A random number generator.

Constructor Detail

AbstractComponent

protected AbstractComponent()

Create a new AbstractComponent.

Method Detail

postConnect

protected final void postConnect(Connection c,
                                 java.util.Collection<Entity> entities,
                                 Config kernelConfig)

Notification that connection to the kernel succeeded.

Parameters:

c - The kernel connection.

entities - The entities that the kernel sent on startup.

kernelConfig - The config that the kernel sent on startup.

postConnect

protected void postConnect()

Perform any post-connection work required before acknowledgement of the connection is made. The default implementation does nothing.

createWorldModel

protected abstract T createWorldModel()

Construct the world model.

Returns:

The world model.

send

protected final void send(Message msg)

Send a message to the kernel and silently ignore any errors.

Parameters:

msg - The message to send.

getPreferredLogContext

public java.lang.String getPreferredLogContext()

Description copied from interface: Component

Get the preferred log context for this component.

Specified by:

getPreferredLogContext in interface Component

Returns:

The preferred log context for this component.

getPreferredNDC

protected java.lang.String getPreferredNDC()

Get the preferred nested diagnostic context to use when processing messages for this component. Default implementation returns null.

Returns:

The preferred NDC for this component, or null if no context is required.

initialise

public void initialise()

Description copied from interface: Component

Initialise this component before connection.

Specified by:

initialise in interface Component

shutdown

public void shutdown()

Description copied from interface: Component

Shut this component down.

Specified by:

shutdown in interface Component

getName

public java.lang.String getName()

Description copied from interface: Component

Get the name of this component. This is useful for debugging. Often a class name will be sufficient.

Specified by:

getName in interface Component

Returns:

A name.

getPreferredRegistry

public Registry getPreferredRegistry(Registry parent)

Description copied from interface: Component

Get the registry this component would like to use for its connection.

Specified by:

getPreferredRegistry in interface Component

Parameters:

parent - The parent registry.

Returns:

The preferred registry.

processMessage

protected void processMessage(Message msg)

Process an incoming message.

Parameters:

msg - The incoming message.

processImmediately

protected boolean processImmediately(Message msg)

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 processMessage(Message) method.

Parameters:

msg - The incoming message.

Returns:

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