rescuecore2.standard.components

Class StandardAgent<E extends StandardEntity>

java.lang.Object

rescuecore2.components.AbstractComponent<T>

rescuecore2.components.AbstractAgent<StandardWorldModel,E>

rescuecore2.standard.components.StandardAgent<E>

Type Parameters:

E - The subclass of StandardEntity that this agent wants to control.

All Implemented Interfaces:

Agent, Component

Direct Known Subclasses:

AbstractSampleAgent, ControlledAmbulanceTeam, ControlledFireBrigade, ControlledPoliceForce, DummyAgent, SampleCentre

public abstract class StandardAgent<E extends StandardEntity>
extends AbstractAgent<StandardWorldModel,E>

Abstract base class for standard agents.

Field Summary

Fields inherited from class rescuecore2.components.AbstractComponent

config, connection, model, random

Constructor Summary

Constructors

Constructor and Description
StandardAgent()

Method Summary

Modifier and Type	Method and Description
protected StandardWorldModel	createWorldModel() Construct the world model.
protected java.util.List<Refuge>	getRefuges() Get a list of all refuges in the world.
java.lang.String[]	getRequestedEntityURNs() Get the list of entity URNs that this agent is willing to control.
protected abstract java.util.EnumSet<StandardEntityURN>	getRequestedEntityURNsEnum() Get an EnumSet containing requested entity URNs.
protected StandardEntity	location() Get the location of the entity controlled by this agent.
protected void	postConnect() Perform any post-connection work required before acknowledgement of the connection is made.
protected void	sendClear(int time, EntityID target) Send a clear command to the kernel.
protected void	sendClear(int time, int destX, int destY) Send a clear command to the kernel.
protected void	sendExtinguish(int time, EntityID target, int water) Send an extinguish command to the kernel.
protected void	sendLoad(int time, EntityID target) Send a load command to the kernel.
protected void	sendMove(int time, java.util.List<EntityID> path) Send a move command to the kernel.
protected void	sendMove(int time, java.util.List<EntityID> path, int destX, int destY) Send a move command to the kernel.
protected void	sendRescue(int time, EntityID target) Send a rescue command to the kernel.
protected void	sendRest(int time) Send a rest command to the kernel.
protected void	sendSay(int time, byte[] data) Send a say command to the kernel.
protected void	sendSpeak(int time, int channel, byte[] data) Send a speak command to the kernel.
protected void	sendSubscribe(int time, int... channels) Send a subscribe command to the kernel.
protected void	sendTell(int time, byte[] data) Send a tell command to the kernel.
protected void	sendUnload(int time) Send an unload command to the kernel.
protected boolean	shouldIndex() Should the world model be automatically indexed?

Methods inherited from class rescuecore2.components.AbstractAgent

connect, getID, getPreferredNDC, me, postConnect, processMessage, processSense, think

Methods inherited from class rescuecore2.components.AbstractComponent

getName, getPreferredLogContext, getPreferredRegistry, initialise, 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

Constructor Detail

StandardAgent

public StandardAgent()

Method Detail

getRequestedEntityURNs

public final java.lang.String[] getRequestedEntityURNs()

Description copied from interface: Agent

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

Returns:

An array of entity URNs.

getRequestedEntityURNsEnum

protected abstract java.util.EnumSet<StandardEntityURN> getRequestedEntityURNsEnum()

Get an EnumSet containing requested entity URNs.

Returns:

An EnumSet containing requested entity URNs.

createWorldModel

protected StandardWorldModel createWorldModel()

Description copied from class: AbstractComponent

Construct the world model.

Specified by:

createWorldModel in class AbstractComponent<StandardWorldModel>

Returns:

The world model.

postConnect

protected void postConnect()

Description copied from class: AbstractComponent

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

Overrides:

postConnect in class AbstractAgent<StandardWorldModel,E extends StandardEntity>

sendRest

protected void sendRest(int time)

Send a rest command to the kernel.

Parameters:

time - The current time.

sendMove

protected void sendMove(int time,
                        java.util.List<EntityID> path)

Send a move command to the kernel.

Parameters:

time - The current time.

path - The path to send.

sendMove

protected void sendMove(int time,
                        java.util.List<EntityID> path,
                        int destX,
                        int destY)

Send a move command to the kernel.

Parameters:

time - The current time.

path - The path to send.

destX - The destination X coordinate.

destY - The destination Y coordinate.

sendExtinguish

protected void sendExtinguish(int time,
                              EntityID target,
                              int water)

Send an extinguish command to the kernel.

Parameters:

time - The current time.

target - The target building.

water - The amount of water to use.

sendClear

protected void sendClear(int time,
                         EntityID target)

Send a clear command to the kernel.

Parameters:

time - The current time.

target - The target road.

sendClear

protected void sendClear(int time,
                         int destX,
                         int destY)

Send a clear command to the kernel.

Parameters:

time - The current time.

destX - The destination X coordinate to clear.

destY - The destination Y coordinate to clear.

sendRescue

protected void sendRescue(int time,
                          EntityID target)

Send a rescue command to the kernel.

Parameters:

time - The current time.

target - The target human.

sendLoad

protected void sendLoad(int time,
                        EntityID target)

Send a load command to the kernel.

Parameters:

time - The current time.

target - The target human.

sendUnload

protected void sendUnload(int time)

Send an unload command to the kernel.

Parameters:

time - The current time.

sendSpeak

protected void sendSpeak(int time,
                         int channel,
                         byte[] data)

Send a speak command to the kernel.

Parameters:

time - The current time.

channel - The channel to speak on.

data - The data to send.

sendSubscribe

protected void sendSubscribe(int time,
                             int... channels)

Send a subscribe command to the kernel.

Parameters:

time - The current time.

channels - The channels to subscribe to.

sendSay

protected void sendSay(int time,
                       byte[] data)

Send a say command to the kernel.

Parameters:

time - The current time.

data - The data to send.

sendTell

protected void sendTell(int time,
                        byte[] data)

Send a tell command to the kernel.

Parameters:

time - The current time.

data - The data to send.

getRefuges

protected java.util.List<Refuge> getRefuges()

Get a list of all refuges in the world.

Returns:

All refuges.

location

protected StandardEntity location()

Get the location of the entity controlled by this agent.

Returns:

The location of the entity controlled by this agent.

shouldIndex

protected boolean shouldIndex()

Should the world model be automatically indexed?

Returns:

True if the world model should be automatically indexed, false otherwise. Default implementation returns true.