hla.rti
Interface SuppliedParameters

public interface SuppliedParameters

This packages the parameters supplied to the RTI for sendInteraction. This is conceptually an array with an initial capacity and the ability to grow. You enumerate by stepping index from 0 to size()-1.

Method Summary

void	add(int handle, byte[] value) Add pair beyond last index.
void	empty() Removes all handles & values.
int	getHandle(int index) Return handle at index position.
byte[]	getValue(int index) Return copy of value at index position.
int	getValueLength(int index) Return length of value at index position.
byte[]	getValueReference(int index) Get the reference of the value at position index (not a clone)
void	remove(int handle) Remove handle & value corresponding to handle.
void	removeAt(int index) Remove handle & value at index position.
int	size()

Method Detail

add

public void add(int handle,
                byte[] value)

Add pair beyond last index.

Parameters:

handle - int

value - byte[]

empty

public void empty()

Removes all handles & values.

getHandle

public int getHandle(int index)
              throws hla.rti.ArrayIndexOutOfBounds

Return handle at index position.

Parameters:

index - int

Returns:

int parameter handle

Throws:

hla.rti.ArrayIndexOutOfBounds -

getValue

public byte[] getValue(int index)
                throws hla.rti.ArrayIndexOutOfBounds

Return copy of value at index position.

Parameters:

index - int

Returns:

byte[] copy (clone) of value

Throws:

hla.rti.ArrayIndexOutOfBounds -

getValueLength

public int getValueLength(int index)
                   throws hla.rti.ArrayIndexOutOfBounds

Return length of value at index position.

Parameters:

index - int

Returns:

int value length

Throws:

hla.rti.ArrayIndexOutOfBounds -

getValueReference

public byte[] getValueReference(int index)
                         throws hla.rti.ArrayIndexOutOfBounds

Get the reference of the value at position index (not a clone)

Parameters:

index - int

Returns:

byte[] the reference

Throws:

hla.rti.ArrayIndexOutOfBounds -

remove

public void remove(int handle)
            throws hla.rti.ArrayIndexOutOfBounds

Remove handle & value corresponding to handle. All other elements shifted down. Not safe during iteration.

Parameters:

handle - int

Throws:

hla.rti.ArrayIndexOutOfBounds - if handle not in set

removeAt

public void removeAt(int index)
              throws hla.rti.ArrayIndexOutOfBounds

Remove handle & value at index position. All other elements shifted down. Not safe during iteration.

Parameters:

index - int

Throws:

hla.rti.ArrayIndexOutOfBounds -

size

public int size()

Returns:

int Number of elements