rescuecore2.messages

Class AbstractCommand

java.lang.Object

rescuecore2.messages.AbstractMessage

rescuecore2.messages.AbstractCommand

All Implemented Interfaces:

Command, Message

Direct Known Subclasses:

AKClear, AKClearArea, AKExtinguish, AKLoad, AKMove, AKRescue, AKRest, AKSay, AKSpeak, AKSubscribe, AKTell, AKUnload

public abstract class AbstractCommand
extends AbstractMessage
implements Command

A sub-interface of Message that tags messages that are interpreted as agent commands.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCommand(java.lang.Enum<?> urn) Construct a new abstract command.
protected	AbstractCommand(java.lang.Enum<?> urn, EntityID agentID, int time) Construct a new abstract command.
protected	AbstractCommand(java.lang.String urn) Construct a new abstract command.
protected	AbstractCommand(java.lang.String urn, EntityID agentID, int time) Construct a new abstract command.

Method Summary

Modifier and Type	Method and Description
EntityID	getAgentID() Get the id of the agent-controlled entity that has issued this command.
int	getTime() Get the timestep this command is intended for.
protected void	setAgentID(EntityID agentID) Set the ID of the agent issuing the command.
protected void	setTime(int time) Set the time of the command.

Methods inherited from class rescuecore2.messages.AbstractMessage

addMessageComponent, getComponents, getURN, read, toString, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface rescuecore2.messages.Message

getURN, read, write

Constructor Detail

AbstractCommand

protected AbstractCommand(java.lang.String urn)

Construct a new abstract command.

Parameters:

urn - The urn of the command.

AbstractCommand

protected AbstractCommand(java.lang.String urn,
                          EntityID agentID,
                          int time)

Construct a new abstract command.

Parameters:

urn - The urn of the command.

agentID - The ID of the agent issuing the command.

time - The time this command was issued.

AbstractCommand

protected AbstractCommand(java.lang.Enum<?> urn)

Construct a new abstract command.

Parameters:

urn - The urn of the command.

AbstractCommand

protected AbstractCommand(java.lang.Enum<?> urn,
                          EntityID agentID,
                          int time)

Construct a new abstract command.

Parameters:

urn - The urn of the command.

agentID - The ID of the agent issuing the command.

time - The time this command was issued.

Method Detail

getAgentID

public EntityID getAgentID()

Description copied from interface: Command

Get the id of the agent-controlled entity that has issued this command.

Specified by:

getAgentID in interface Command

Returns:

The id of the agent.

getTime

public int getTime()

Description copied from interface: Command

Get the timestep this command is intended for.

Specified by:

getTime in interface Command

Returns:

The timestep.

setAgentID

protected void setAgentID(EntityID agentID)

Set the ID of the agent issuing the command.

Parameters:

agentID - The new agent ID.

setTime

protected void setTime(int time)

Set the time of the command.

Parameters:

time - The new time.