org.npsnet.xrti
Class RegionDescriptor

java.lang.Object
  org.npsnet.xrti.RegionDescriptor

public class RegionDescriptor

extends java.lang.Object

Describes a region.

Author:

Andrzej Kapolka

Field Summary

private java.util.HashMap	dimensionRangeBoundsMap Maps dimension handles to range bounds.
private DimensionHandleSet	dimensions The dimensions of the region.
private RegionHandle	handle The handle of the region.

Constructor Summary

RegionDescriptor(RegionHandle pHandle, DimensionHandleSet pDimensions)
Constructor.

Method Summary

DimensionHandleSet	getDimensions() Returns the dimensions of this region.
RegionHandle	getHandle() Returns the handle of this region.
RangeBounds	getRangeBounds(DimensionHandle dimension) Returns the range bounds for the specified dimension.
void	setRangeBounds(DimensionHandle dimension, RangeBounds bounds) Sets the range bounds for the specified dimension.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

handle

private RegionHandle handle

The handle of the region.

dimensions

private DimensionHandleSet dimensions

The dimensions of the region.

dimensionRangeBoundsMap

private java.util.HashMap dimensionRangeBoundsMap

Maps dimension handles to range bounds.

Constructor Detail

RegionDescriptor

public RegionDescriptor(RegionHandle pHandle,
                        DimensionHandleSet pDimensions)

Constructor.

Parameters:

pHandle - the handle of the region

pDimensions - the dimensions of the region

Method Detail

getHandle

public RegionHandle getHandle()

Returns the handle of this region.

Returns:

the handle of this region.

getDimensions

public DimensionHandleSet getDimensions()

Returns the dimensions of this region.

Returns:

the dimensions of this region

setRangeBounds

public void setRangeBounds(DimensionHandle dimension,
                           RangeBounds bounds)

Sets the range bounds for the specified dimension.

Parameters:

dimension - the handle of the dimension

bounds - the new bounds for the dimension

getRangeBounds

public RangeBounds getRangeBounds(DimensionHandle dimension)

Returns the range bounds for the specified dimension.

Parameters:

dimension - the handle of the dimension of interest

Returns:

the range bounds of the specified dimension, or null if no such dimension exists