hla.rti
Interface FederateHandle

All Superinterfaces:

java.io.Serializable

public interface FederateHandle

extends java.io.Serializable

Type-safe handle for a federate. Generally these are created by the RTI and passed to the user.

Author:

DMSO

Method Summary

void	encode(byte[] buffer, int offset) Encodes this federate handle, placing the result into the specified byte array.
int	encodedLength() Returns the encoded length of this federate handle.
boolean	equals(java.lang.Object otherFederateHandle) Tests this federate handle for equality with another.
int	hashCode() Computes and returns the hash code corresponding to this federate handle.
java.lang.String	toString() Returns a string representation of this federate handle.

Method Detail

equals

public boolean equals(java.lang.Object otherFederateHandle)

Tests this federate handle for equality with another.

Parameters:

otherFederateHandle - the other federate handle to compare this to

Returns:

true if this refers to the same federate as other handle, false otherwise

hashCode

public int hashCode()

Computes and returns the hash code corresponding to this federate handle.

Returns:

the hash code corresponding to this federate handle

encodedLength

public int encodedLength()

Returns the encoded length of this federate handle.

Returns:

the encoded length of this federate handle (in bytes)

encode

public void encode(byte[] buffer,
                   int offset)

Encodes this federate handle, placing the result into the specified byte array.

Parameters:

buffer - the buffer to hold the encoded federate handle

offset - the offset within the buffer at which to store the encoded handle

toString

public java.lang.String toString()

Returns a string representation of this federate handle.

Returns:

a string representation of this federate handle