ucar.visad.display
Class SelectRangeDisplayable

java.lang.Object
  extended by ucar.visad.display.Displayable
      extended by ucar.visad.display.SelectRangeDisplayable

public class SelectRangeDisplayable
extends Displayable

A class for support of a select range scalar map.

Version:
$Revision: 1.4 $
Author:
IDV Development Team

Field Summary
 
Fields inherited from class ucar.visad.display.Displayable
DISPLAY, parent, SCALAR_MAP_SET
 
Constructor Summary
  SelectRangeDisplayable()
          Default ctor.
  SelectRangeDisplayable(RealType rangeType)
          Create a select range displayable for the particular type.
protected SelectRangeDisplayable(SelectRangeDisplayable that)
          Constructs from a SelectRangeDisplayable.
 
Method Summary
 Displayable cloneForDisplay()
          Returns a clone of this instance suitable for another VisAD display.
 RealType getSelectRealType()
          Returns the RealType of the SelectRange parameter.
 boolean hasSelectedRange()
          Returns whether this Displayable has a valid range (i.e., lowSelectedRange and highSelectedRange are both not NaN's
 void myAddDataReferences()
          Adds the DataReferences associated with this instance to the display.
 void myRemoveDataReferences()
          Removes the DataReferences associated with this instance from the display.
 void setDisplayUnit(Unit unit)
          Set the units for the displayed range
 void setRangeForSelect(double low, double hi)
          Set the upper and lower limit of the range values associated with a color table.
 void setSelectedRange(double low, double hi)
          Set selected range with the range for select
 void setSelectRealType(RealType realType)
          Sets the RealType of the select parameter.
 
Methods inherited from class ucar.visad.display.Displayable
addConstantMap, addConstantMaps, addDataReferences, addPropertyChangeListener, addPropertyChangeListener, addRefsInvoked, addScalarMap, addScalarMaps, applyColorUnit, applyDisplayUnit, checkUnit, combineConstantMaps, destroy, firePropertyChange, firePropertyChange, fireScalarMapSetChange, getAnimationSet, getColorUnit, getConstantMaps, getData, getDisplay, getDisplayMaster, getDisplayUnit, getPointMode, getScalarMap, getScalarMap, getScalarMap, getScalarMapSet, getUseFastRendering, getUseTimesInAnimation, getVisible, hasDataObject, isActive, isUnitCompatible, isVisible, logException, myAddConstantMaps, removeConstantMap, removeDataReferences, removePropertyChangeListener, removePropertyChangeListener, removeScalarMap, replaceScalarMap, setAdjustFlow, setColor, setColorPalette, setColorPalette, setColorUnit, setConstantPosition, setContourInfo, setDisplay, setDisplayActive, setDisplayInactive, setDisplayMaster, setLineWidth, setOverrideAnimationSet, setOverrideAnimationSet, setParent, setPointMode, setPointSize, setRangeForColor, setRangeForColor, setScalarMapSet, setSelectedRange, setUseFastRendering, setUseTimesInAnimation, setVisible, toFront
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SelectRangeDisplayable

public SelectRangeDisplayable()
                       throws VisADException,
                              RemoteException
Default ctor.

Throws:
VisADException - VisAD failure.
RemoteException - Java RMI failure.

SelectRangeDisplayable

public SelectRangeDisplayable(RealType rangeType)
                       throws VisADException,
                              RemoteException
Create a select range displayable for the particular type.

Parameters:
rangeType - RealType for the select range
Throws:
VisADException - VisAD failure.
RemoteException - Java RMI failure.

SelectRangeDisplayable

protected SelectRangeDisplayable(SelectRangeDisplayable that)
                          throws VisADException,
                                 RemoteException
Constructs from a SelectRangeDisplayable.

Parameters:
that - a SelectRangeDisplayable.
Throws:
VisADException - VisAD failure.
RemoteException - Java RMI failure.
Method Detail

setSelectRealType

public void setSelectRealType(RealType realType)
                       throws RemoteException,
                              VisADException
Sets the RealType of the select parameter.

Parameters:
realType - The RealType of the RGB parameter. May not be null.
Throws:
VisADException - VisAD failure.
RemoteException - Java RMI failure.

getSelectRealType

public RealType getSelectRealType()
Returns the RealType of the SelectRange parameter.

Returns:
The RealType of the select range parameter. May be null.

myAddDataReferences

public final void myAddDataReferences()

Adds the DataReferences associated with this instance to the display.

This implementation does nothing.

Specified by:
myAddDataReferences in class Displayable

myRemoveDataReferences

public final void myRemoveDataReferences()

Removes the DataReferences associated with this instance from the display.

This implementation does nothing.

Specified by:
myRemoveDataReferences in class Displayable

hasSelectedRange

public boolean hasSelectedRange()
Returns whether this Displayable has a valid range (i.e., lowSelectedRange and highSelectedRange are both not NaN's

Returns:
true if range has been set

setSelectedRange

public void setSelectedRange(double low,
                             double hi)
                      throws VisADException,
                             RemoteException
Set selected range with the range for select

Overrides:
setSelectedRange in class Displayable
Parameters:
low - low select value
hi - hi select value
Throws:
RemoteException - Java RMI error
VisADException - problem creating VisAD object

setDisplayUnit

public void setDisplayUnit(Unit unit)
                    throws VisADException,
                           RemoteException
Set the units for the displayed range

Overrides:
setDisplayUnit in class Displayable
Parameters:
unit - Unit for display
Throws:
RemoteException - Java RMI error
VisADException - problem creating VisAD object

setRangeForSelect

public void setRangeForSelect(double low,
                              double hi)
                       throws VisADException,
                              RemoteException
Set the upper and lower limit of the range values associated with a color table.

Parameters:
low - the minimun value
hi - the maximum value
Throws:
RemoteException - Java RMI error
VisADException - problem creating VisAD object

cloneForDisplay

public Displayable cloneForDisplay()
                            throws RemoteException,
                                   VisADException
Returns a clone of this instance suitable for another VisAD display. Underlying data objects are not cloned.

Specified by:
cloneForDisplay in class Displayable
Returns:
A semi-deep clone of this instance.
Throws:
VisADException - VisAD failure.
RemoteException - Java RMI failure.