rescuecore2.components

Interface Agent

All Superinterfaces:

Component

All Known Implementing Classes:

AbstractAgent, AbstractSampleAgent, ChannelTestAgent, ControlledAmbulanceTeam, ControlledFireBrigade, ControlledPoliceForce, CustomRegistryTestAgent, DummyAgent, SampleAmbulanceTeam, SampleCentre, SampleCivilian, SampleFireBrigade, SamplePoliceForce, StandardAgent

public interface Agent
extends Component

Sub-interface for Agent components.

Method Summary

Modifier and Type	Method and Description
EntityID	getID() Get the ID of the entity this agent controls.
java.lang.String[]	getRequestedEntityURNs() Get the list of entity URNs that this agent is willing to control.
void	postConnect(Connection c, EntityID agentID, java.util.Collection<Entity> entities, Config config) Notification that this agent has been connected to the kernel.

Methods inherited from interface rescuecore2.components.Component

connect, getName, getPreferredLogContext, getPreferredRegistry, initialise, shutdown

Method Detail

getRequestedEntityURNs

java.lang.String[] getRequestedEntityURNs()

Get the list of entity URNs that this agent is willing to control.

Returns:

An array of entity URNs.

postConnect

void postConnect(Connection c,
                 EntityID agentID,
                 java.util.Collection<Entity> entities,
                 Config config)

Notification that this agent has been connected to the kernel.

Parameters:

c - The connection to the kernel.

agentID - The ID of the entity controlled by this agent.

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

config - The Config the kernel send to this agent on connection.

getID

EntityID getID()

Get the ID of the entity this agent controls. If the agent has not yet been connected to the kernel then null will be returned.

Returns:

The entity ID or null if this agent is not yet connected.