rescuecore2.components

Interface Component

All Known Subinterfaces:

Agent, Simulator, Viewer

All Known Implementing Classes:

AbstractAgent, AbstractComponent, AbstractSampleAgent, AbstractSimulator, AbstractViewer, ChannelTestAgent, ClearSimulator, CollapseSimulator, ControlledAmbulanceTeam, ControlledFireBrigade, ControlledPoliceForce, CustomRegistryTestAgent, DummyAgent, FireSimulatorWrapper, IgnitionSimulator, LiveLogExtractor, MiscSimulator, SampleAmbulanceTeam, SampleCentre, SampleCivilian, SampleFireBrigade, SamplePoliceForce, SampleSimulator, SampleViewer, StandardAgent, StandardSimulator, StandardViewer, TrafficSimulator

public interface Component

Top-level interface for components of the Robocup Rescue simulation. Agents, simulators and viewers are all components.

Method Summary

Modifier and Type	Method and Description
void	connect(Connection connection, RequestIDGenerator generator, Config config) Connect this component to the kernel.
java.lang.String	getName() Get the name of this component.
java.lang.String	getPreferredLogContext() Get the preferred log context 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.
void	shutdown() Shut this component down.

Method Detail

initialise

void initialise()
         throws ComponentInitialisationException

Initialise this component before connection.

Throws:

ComponentInitialisationException - If there is a problem initialising the component.

shutdown

void shutdown()

Shut this component down.

getName

java.lang.String getName()

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

Returns:

A name.

getPreferredRegistry

Registry getPreferredRegistry(Registry parent)

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

Parameters:

parent - The parent registry.

Returns:

The preferred registry.

getPreferredLogContext

java.lang.String getPreferredLogContext()

Get the preferred log context for this component.

Returns:

The preferred log context for this component.

connect

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

Connect this component to the kernel.

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.