rescuecore2.messages.control

Class KVTimestep

java.lang.Object

rescuecore2.messages.AbstractMessage

rescuecore2.messages.control.KVTimestep

All Implemented Interfaces:

Control, Message

public class KVTimestep
extends AbstractMessage
implements Control

A message containing a timestep summary. This is sent from the kernel to all viewers.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ChangeSet	getChangeSet() Get the list of changes.
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

KVTimestep

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

A KVTimestep 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.

KVTimestep

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

A populated KVTimestep message.

Parameters:

id - The id of the viewer receiving the update.

time - The timestep of the simulation.

commands - All agent Commands.

changes - Summary of changes during the timestep.

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.

getChangeSet

public ChangeSet getChangeSet()

Get the list of changes.

Returns:

The changes.