rescuecore2.messages.control

Class KAConnectOK

java.lang.Object

rescuecore2.messages.AbstractMessage

rescuecore2.messages.control.KAConnectOK

All Implemented Interfaces:

Control, Message

public class KAConnectOK
extends AbstractMessage
implements Control

A message for signalling a successful connection to the kernel.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
EntityID	getAgentID() Get the ID of the agent-controlled object.
Config	getConfig() Get the Config.
java.util.Collection<Entity>	getEntities() Get the entity list.
int	getRequestID() Get the requestID 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

KAConnectOK

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

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

KAConnectOK

public KAConnectOK(int requestID,
                   EntityID agentID,
                   java.util.Collection<? extends Entity> allEntities,
                   Config config)

A populated KAConnectOK message.

Parameters:

requestID - The request ID.

agentID - The ID of the Entity that the agent will be controlling.

allEntities - All Entities that the agent knows about, including the controlled object.

config - The Config that the agent knows about.

Method Detail

getRequestID

public int getRequestID()

Get the requestID for this message.

Returns:

The request ID.

getAgentID

public EntityID getAgentID()

Get the ID of the agent-controlled object.

Returns:

The agent 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 agent config.