hla.rti
Interface DimensionHandle

All Superinterfaces:

java.io.Serializable

public interface DimensionHandle

extends java.io.Serializable

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

Author:

DMSO

Method Summary

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

Method Detail

equals

public boolean equals(java.lang.Object otherDimensionHandle)

Checks this dimension handle for equality with another.

Parameters:

otherDimensionHandle - the dimension handle to compare this to

Returns:

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

hashCode

public int hashCode()

Computes and returns a hash code corresponding to this dimension handle.

Returns:

the hash code corresponding to this dimension handle

encodedLength

public int encodedLength()

Returns the encoded length of this dimension handle.

Returns:

the encoded length of this dimension handle (in bytes)

encode

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

Encodes this dimension handle, placing the result into the specified buffer.

Parameters:

buffer - the buffer to contain the encoded dimension handle

offset - the offset within the buffer at which to place the encoded dimension handle

toString

public java.lang.String toString()

Returns a string representation of this dimension handle.

Returns:

a string representation of this dimension handle