ucar.unidata.view.sounding

Class WindStaff

java.lang.Object

ucar.visad.display.Displayable

ucar.visad.display.CompositeDisplayable

ucar.unidata.view.sounding.WindProfile

ucar.unidata.view.sounding.WindStaff

public class WindStaff
extends WindProfile

Provides support for the display of a wind profile as a collection of wind arrows.

Version:

$Id: WindStaff.java,v 1.28 2006/05/02 14:54:27 dmurray Exp $

Author:

Steven R. Emmerson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	WindStaff.ArrowMapSetListener Provides support for observing changes in the set of ScalarMap-s of a WindArrow.
protected class	WindStaff.ArrowWindListener Provides support for observing changes in the "wind" property of a WindArrow.

Field Summary

Fields inherited from class ucar.unidata.view.sounding.WindProfile

DIRECTION, GEOPOTENTIAL_ALTITUDE, GEOPOTENTIAL_ALTITUDE_EXTENT, MAXIMUM_SPEED, PRESSURE, SPEED, WIND_PROFILE

Fields inherited from class ucar.visad.display.CompositeDisplayable

cnt, label

Fields inherited from class ucar.visad.display.Displayable

DISPLAY, parent, SCALAR_MAP_SET

Constructor Summary

Constructors

Modifier	Constructor and Description
	WindStaff(visad.LocalDisplay display) Constructs from a VisAD display.
	WindStaff(visad.LocalDisplay display, visad.TupleType tupleType) Constructs from a VisAD display.
protected	WindStaff(WindStaff that) Constructs from another instance.

Method Summary

Modifier and Type	Method and Description
Displayable	cloneForDisplay() Returns a clone of this instance suitable for another VisAD display.
boolean	equals(java.lang.Object obj) Indicates if this instance is identical to another object.
static visad.RealType	getGeopotentialAltitudeRealType() Returns the type of the geopotential altitude quantity.
protected visad.FlatField	getMissingWindField() Returns an instance of a wind field with no values.
protected visad.Field	getProfile() Returns the wind profile.
static visad.RealType	getSoutherlyWindRealType() Returns the type of the southerly wind quantity.
visad.RealType	getVerticalComponentRealType() Returns the type of the vertical component of the profile quantity.
static visad.RealType	getWesterlyWindRealType() Returns the type of the westerly wind quantity.
int	hashCode() Returns the hash code of this instance.
void	setDisplay(visad.LocalDisplay display) Associates this instance with a given VisAD display.
void	setOriginalProfile() Resets the vertical profile of the horizontal wind to the profile of the last setProfile().
void	setProfile(visad.Field profile) Sets the wind profile.
protected void	setWindArrows() Sets the wind arrows.
void	setWindLevels(visad.Gridded1DSet levels) Set the levels of the wind profile to display.

Methods inherited from class ucar.unidata.view.sounding.WindProfile

ensureCartesian, getDirection, getGeopotentialAltitude, getGeopotentialAltitudeExtent, getMaximumSpeed, getPressure, getSpeed, profileChange, setAltitudeExtent, setDirection, setGeopotentialAltitude, setMaximumSpeed, setPressure, setSpeed, setSpeedAndDirection

Methods inherited from class ucar.visad.display.CompositeDisplayable

addConstantMap, addDisplayable, addListDataListener, clearDisplayables, debug, destroy, destroyAll, displayableCount, fireListDataContentsChanged, fireListDataIntervalAdded, fireListDataIntervalRemoved, getAnimationSet, getDisplayable, indexOf, iterator, lastDisplayable, myAddDataReferences, myRemoveDataReferences, removeDisplayable, removeDisplayable, removeListDataListener, setAdjustFlow, setColor, setColorPalette, setColorUnit, setConstantPosition, setDisplayable, setDisplayMaster, setDisplayUnit, setLineWidth, setManipulable, setPointMode, setPointSize, setSelectedRange, setUseFastRendering, setUseTimesInAnimation, setVisible, setVisible, setVisible, toFront, toString

Methods inherited from class ucar.visad.display.Displayable

addConstantMaps, addDataReferences, addPropertyChangeListener, addPropertyChangeListener, addRefsInvoked, addScalarMap, addScalarMaps, applyColorUnit, applyDisplayUnit, checkUnit, combineConstantMaps, destroyDisplayable, firePropertyChange, firePropertyChange, fireScalarMapSetChange, getColorUnit, getConstantMaps, getData, getDestroyed, getDisplay, getDisplayMaster, getDisplayUnit, getPointMode, getScalarMap, getScalarMap, getScalarMap, getScalarMapSet, getUseFastRendering, getUseTimesInAnimation, getVisible, hasDataObject, isActive, isUnitCompatible, isVisible, logException, myAddConstantMaps, removeConstantMap, removeDataReferences, removePropertyChangeListener, removePropertyChangeListener, removeScalarMap, replaceScalarMap, setColorPalette, setContourInfo, setDisplayActive, setDisplayInactive, setOverrideAnimationSet, setOverrideAnimationSet, setParent, setRangeForColor, setRangeForColor, setScalarMapSet, setSelectedRange

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WindStaff

public WindStaff(visad.LocalDisplay display)
          throws visad.VisADException,
                 java.rmi.RemoteException

Constructs from a VisAD display.

Parameters:

display - The VisAD display.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

WindStaff

public WindStaff(visad.LocalDisplay display,
                 visad.TupleType tupleType)
          throws visad.VisADException,
                 java.rmi.RemoteException

Constructs from a VisAD display.

Parameters:

display - The VisAD display.

tupleType - TupleType for arrows

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

WindStaff

protected WindStaff(WindStaff that)
             throws java.rmi.RemoteException,
                    visad.VisADException

Constructs from another instance.

Parameters:

that - The other instance.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

Method Detail

getMissingWindField

protected visad.FlatField getMissingWindField()

Returns an instance of a wind field with no values.

Overrides:

getMissingWindField in class WindProfile

Returns:

A wind field with no values.

setProfile

public void setProfile(visad.Field profile)
                throws visad.VisADException,
                       java.rmi.RemoteException

Sets the wind profile.

Specified by:

setProfile in class WindProfile

Parameters:

profile - The wind profile.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

setOriginalProfile

public void setOriginalProfile()
                        throws visad.VisADException,
                               java.rmi.RemoteException

Resets the vertical profile of the horizontal wind to the profile of the last setProfile().

Specified by:

setOriginalProfile in class WindProfile

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

setDisplay

public void setDisplay(visad.LocalDisplay display)
                throws java.rmi.RemoteException,
                       visad.VisADException

Associates this instance with a given VisAD display. If this instance was previously associated with a VisAD display, then it is first removed from that display. This method fires a PropertyChangeEvent for DISPLAY with the old and new values. This method will not cause this instance to be rendered in the display. This method may be overridden in subclasses; the overriding method should invoke super.setDisplay(display).

Overrides:

setDisplay in class CompositeDisplayable

Parameters:

display - The VisAD display. May not be null.

Throws:

java.lang.NullPointerException - The display is null.

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

See Also:

Displayable.removeDataReferences()

getProfile

protected visad.Field getProfile()

Returns the wind profile.

Specified by:

getProfile in class WindProfile

Returns:

The wind profile.

getGeopotentialAltitudeRealType

public static visad.RealType getGeopotentialAltitudeRealType()
                                                      throws visad.VisADException

Returns the type of the geopotential altitude quantity.

Returns:

The type of the geopotential altitude quantity.

Throws:

visad.VisADException - VisAD failure.

getVerticalComponentRealType

public visad.RealType getVerticalComponentRealType()
                                            throws visad.VisADException

Returns the type of the vertical component of the profile quantity.

Returns:

The type of the vertical quantity.

Throws:

visad.VisADException - VisAD failure.

getWesterlyWindRealType

public static visad.RealType getWesterlyWindRealType()
                                              throws visad.VisADException

Returns the type of the westerly wind quantity.

Returns:

The type of the westerly wind quantity.

Throws:

visad.VisADException - VisAD failure.

getSoutherlyWindRealType

public static visad.RealType getSoutherlyWindRealType()
                                               throws visad.VisADException

Returns the type of the southerly wind quantity.

Returns:

The type of the southerly wind quantity.

Throws:

visad.VisADException - VisAD failure.

setWindLevels

public void setWindLevels(visad.Gridded1DSet levels)
                   throws visad.VisADException,
                          java.rmi.RemoteException

Set the levels of the wind profile to display.

Specified by:

setWindLevels in class WindProfile

Parameters:

levels - the set of levels (if null, display all);

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

setWindArrows

protected void setWindArrows()
                      throws java.rmi.RemoteException,
                             visad.VisADException

Sets the wind arrows.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

equals

public boolean equals(java.lang.Object obj)

Indicates if this instance is identical to another object.

Overrides:

equals in class WindProfile

Parameters:

obj - The other object.

Returns:

true if and only if this instance is identical to the other object.

hashCode

public int hashCode()

Returns the hash code of this instance.

Overrides:

hashCode in class WindProfile

Returns:

The hash code of this instance.

cloneForDisplay

public Displayable cloneForDisplay()
                            throws java.rmi.RemoteException,
                                   visad.VisADException

Returns a clone of this instance suitable for another VisAD display. Underlying data objects are not cloned.

Overrides:

cloneForDisplay in class CompositeDisplayable

Returns:

A clone of this instance.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.