hla.rti
Class RestoreStatus

java.lang.Object
  extended byhla.rti.RestoreStatus
All Implemented Interfaces:
java.io.Serializable

public final class RestoreStatus
extends java.lang.Object
implements java.io.Serializable

Represents a restoration status.

Author:
DMSO
See Also:
Serialized Form

Field Summary
static RestoreStatus FEDERATE_PREPARED_TO_RESTORE
          The federate is prepared to perform a restoration operation.
static RestoreStatus FEDERATE_RESTORE_REQUEST_PENDING
          The federate's request for a restoration operation is pending.
static RestoreStatus FEDERATE_RESTORING
          The federate is currently performing a restoration operation.
static RestoreStatus FEDERATE_WAITING_FOR_FEDERATION_TO_RESTORE
          The federate is waiting for the federation to be restored.
static RestoreStatus FEDERATE_WAITING_FOR_RESTORE_TO_BEGIN
          The federate is waiting for a restoration operation to begin.
static RestoreStatus NO_RESTORE_IN_PROGRESS
          No restoration operation is in progress.
 
Constructor Summary
RestoreStatus(RestoreStatus otherRestoreStatus)
          Copy constructor.
 
Method Summary
 boolean equals(java.lang.Object otherRestoreStatus)
          Compares this restoration status for equality with another.
 int hashCode()
          Computes and returns a hash code corresponding to this restoration status.
 java.lang.String toString()
          Returns a string representation of this restoration status.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

NO_RESTORE_IN_PROGRESS

public static final RestoreStatus NO_RESTORE_IN_PROGRESS
No restoration operation is in progress.


FEDERATE_RESTORE_REQUEST_PENDING

public static final RestoreStatus FEDERATE_RESTORE_REQUEST_PENDING
The federate's request for a restoration operation is pending.


FEDERATE_WAITING_FOR_RESTORE_TO_BEGIN

public static final RestoreStatus FEDERATE_WAITING_FOR_RESTORE_TO_BEGIN
The federate is waiting for a restoration operation to begin.


FEDERATE_PREPARED_TO_RESTORE

public static final RestoreStatus FEDERATE_PREPARED_TO_RESTORE
The federate is prepared to perform a restoration operation.


FEDERATE_RESTORING

public static final RestoreStatus FEDERATE_RESTORING
The federate is currently performing a restoration operation.


FEDERATE_WAITING_FOR_FEDERATION_TO_RESTORE

public static final RestoreStatus FEDERATE_WAITING_FOR_FEDERATION_TO_RESTORE
The federate is waiting for the federation to be restored.

Constructor Detail

RestoreStatus

public RestoreStatus(RestoreStatus otherRestoreStatus)
Copy constructor.

Parameters:
otherRestoreStatus - the restoration status object to copy
Method Detail

equals

public boolean equals(java.lang.Object otherRestoreStatus)
Compares this restoration status for equality with another.

Returns:
true if the two restoration status objects are equal, false otherwise

hashCode

public int hashCode()
Computes and returns a hash code corresponding to this restoration status.

Returns:
a hash code corresponding to this restoration status

toString

public java.lang.String toString()
Returns a string representation of this restoration status.

Returns:
a string representation of this restoration status