rescuecore2.messages.control

Class EntityIDRequest

java.lang.Object

rescuecore2.messages.AbstractMessage

rescuecore2.messages.control.EntityIDRequest

All Implemented Interfaces:

Control, Message

public class EntityIDRequest
extends AbstractMessage
implements Control

A message from a simulator requesting a new EntityID.

Constructor Summary

Constructors

Constructor and Description
EntityIDRequest(java.io.InputStream in) Construct an EntityIDRequest message that populates its data from a stream.
EntityIDRequest(int simID, int requestID, int number) Construct an EntityIDRequest message.

Method Summary

Modifier and Type	Method and Description
int	getCount() Get the number of IDs requested.
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

EntityIDRequest

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

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

EntityIDRequest

public EntityIDRequest(int simID,
                       int requestID,
                       int number)

Construct an EntityIDRequest message.

Parameters:

simID - The ID of the simulator making the request.

requestID - A unique ID number for this request.

number - The number of IDs requested.

Method Detail

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.

getCount

public int getCount()

Get the number of IDs requested.

Returns:

The number of IDs requested.