rescuecore2.messages.control

Class KSCommands

java.lang.Object

rescuecore2.messages.AbstractMessage

rescuecore2.messages.control.KSCommands

All Implemented Interfaces:

Control, Message

public class KSCommands
extends AbstractMessage
implements Control

A message containing a list of agent commands. This is sent from the kernel to all simulators.

Constructor Summary

Constructors

Constructor and Description
KSCommands(java.io.InputStream in) A KSCommands message that populates its data from a stream.
KSCommands(int id, int time, java.util.Collection<? extends Command> commands) A populated KSCommands message.

Method Summary

Modifier and Type	Method and Description
java.util.List<Command>	getCommands() Get the list of agent commands.
int	getTargetID() Get the id of the component that this message is addressed to.
int	getTime() Get the time of the simulation.

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

KSCommands

public KSCommands(java.io.InputStream in)
           throws java.io.IOException

A KSCommands message that populates its data from a stream.

Parameters:

in - The InputStream to read.

Throws:

java.io.IOException - If there is a problem reading the stream.

KSCommands

public KSCommands(int id,
                  int time,
                  java.util.Collection<? extends Command> commands)

A populated KSCommands message.

Parameters:

id - The id of the simulator receiving the update.

time - The timestep of the simulation.

commands - All agent Commands.

Method Detail

getTargetID

public int getTargetID()

Get the id of the component that this message is addressed to.

Returns:

The ID of the target component.

getTime

public int getTime()

Get the time of the simulation.

Returns:

The simulation time.

getCommands

public java.util.List<Command> getCommands()

Get the list of agent commands.

Returns:

The agent commands.