rescuecore2.messages.control

Class EntityIDResponse

java.lang.Object

rescuecore2.messages.AbstractMessage

rescuecore2.messages.control.EntityIDResponse

All Implemented Interfaces:

Control, Message

public class EntityIDResponse
extends AbstractMessage
implements Control

A message from a the kernel supplying a new EntityID.

Constructor Summary

Constructors

Constructor and Description
EntityIDResponse(java.io.InputStream in) Construct an EntityIDResponse message that populates its data from a stream.
EntityIDResponse(int simID, int requestID, EntityID... ids) Construct an EntityIDResponse message.
EntityIDResponse(int simID, int requestID, java.util.List<EntityID> ids) Construct an EntityIDResponse message.

Method Summary

Modifier and Type	Method and Description
java.util.List<EntityID>	getEntityIDs() Get the new entity IDs.
int	getRequestID() Get the ID of this request.
int	getSimulatorID() Get the ID of the simulator making the request.

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

EntityIDResponse

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

Construct an EntityIDResponse 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.

EntityIDResponse

public EntityIDResponse(int simID,
                        int requestID,
                        EntityID... ids)

Construct an EntityIDResponse message.

Parameters:

simID - The ID of the simulator making the request.

requestID - A unique ID number for this request.

ids - The new EntityIDs.

EntityIDResponse

public EntityIDResponse(int simID,
                        int requestID,
                        java.util.List<EntityID> ids)

Construct an EntityIDResponse message.

Parameters:

simID - The ID of the simulator making the request.

requestID - A unique ID number for this request.

ids - The new EntityIDs.

Method Detail

getEntityIDs

public java.util.List<EntityID> getEntityIDs()

Get the new entity IDs.

Returns:

The new entity IDs.

getSimulatorID

public int getSimulatorID()

Get the ID of the simulator making the request.

Returns:

The simulator ID.

getRequestID

public int getRequestID()

Get the ID of this request.

Returns:

The request ID.