hla.rti
Interface Region

public interface Region

Represents a Region in federate's space. A federate creates a Region by calling RTIambassador.createRegion. The federate mdifies the Region by invoking Region methods on it. The federate modifies a Region by first modifying its local instance, then supplying the modified instance to RTIambassador.notifyOfRegionModification. The Region is conceptually an array, with the extents addressed by index running from 0 to getNumberOfExtents()-1.

Method Summary

long	getNumberOfExtents()
long	getRangeLowerBound(int extentIndex, int dimensionHandle)
long	getRangeUpperBound(int extentIndex, int dimensionHandle)
int	getSpaceHandle()
void	setRangeLowerBound(int extentIndex, int dimensionHandle, long newLowerBound) Modify lower bound of extent along indicated dimension.
void	setRangeUpperBound(int extentIndex, int dimensionHandle, long newUpperBound) Modify upper bound of extent along indicated dimension.

Method Detail

getNumberOfExtents

public long getNumberOfExtents()

Returns:

long Number of extents in this Region

getRangeLowerBound

public long getRangeLowerBound(int extentIndex,
                               int dimensionHandle)
                        throws hla.rti.ArrayIndexOutOfBounds

Parameters:

extentIndex - int

dimensionHandle - int

Returns:

long Lower bound of extent along indicated dimension

Throws:

hla.rti.ArrayIndexOutOfBounds -

getRangeUpperBound

public long getRangeUpperBound(int extentIndex,
                               int dimensionHandle)
                        throws hla.rti.ArrayIndexOutOfBounds

Parameters:

extentIndex - int

dimensionHandle - int

Returns:

long Upper bound of extent along indicated dimension

Throws:

hla.rti.ArrayIndexOutOfBounds -

getSpaceHandle

public int getSpaceHandle()

Returns:

int Handle of routing space of which this Region is a subset

setRangeLowerBound

public void setRangeLowerBound(int extentIndex,
                               int dimensionHandle,
                               long newLowerBound)
                        throws hla.rti.ArrayIndexOutOfBounds

Modify lower bound of extent along indicated dimension.

Parameters:

extentIndex - int

dimensionHandle - int

newLowerBound - long

Throws:

hla.rti.ArrayIndexOutOfBounds -

setRangeUpperBound

public void setRangeUpperBound(int extentIndex,
                               int dimensionHandle,
                               long newUpperBound)
                        throws hla.rti.ArrayIndexOutOfBounds

Modify upper bound of extent along indicated dimension.

Parameters:

extentIndex - int

dimensionHandle - int

newUpperBound - long

Throws:

hla.rti.ArrayIndexOutOfBounds - The exception description.