rescuecore2.messages.control

Class KSConnectOK

java.lang.Object

rescuecore2.messages.AbstractMessage

rescuecore2.messages.control.KSConnectOK

All Implemented Interfaces:

Control, Message

public class KSConnectOK
extends AbstractMessage
implements Control

A message for signalling a successful connection to the kernel.

Constructor Summary

Constructors

Constructor and Description
KSConnectOK(java.io.InputStream in) A KSConnectOK message that populates its data from a stream.
KSConnectOK(int simulatorID, int requestID, java.util.Collection<? extends Entity> allEntities, Config config) A populated KSConnectOK message.

Method Summary

Modifier and Type	Method and Description
Config	getConfig() Get the Config.
java.util.Collection<Entity>	getEntities() Get the entity list.
int	getRequestID() Get the request ID.
int	getSimulatorID() Get the simulator ID for this message.

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

KSConnectOK

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

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

KSConnectOK

public KSConnectOK(int simulatorID,
                   int requestID,
                   java.util.Collection<? extends Entity> allEntities,
                   Config config)

A populated KSConnectOK message.

Parameters:

simulatorID - The ID of the simulator that has successfully connected.

requestID - The request ID.

allEntities - All Entities in the world.

config - The Config that the simulator knows about.

Method Detail

getSimulatorID

public int getSimulatorID()

Get the simulator ID for this message.

Returns:

The simulator ID.

getRequestID

public int getRequestID()

Get the request ID.

Returns:

The request ID.

getEntities

public java.util.Collection<Entity> getEntities()

Get the entity list.

Returns:

All entities in the world.

getConfig

public Config getConfig()

Get the Config.

Returns:

The simulator config.