ucar.unidata.view.sounding

Class WindProfile

java.lang.Object

ucar.visad.display.Displayable

ucar.visad.display.CompositeDisplayable

ucar.unidata.view.sounding.WindProfile

Direct Known Subclasses:

WindBarbProfile, WindStaff, WindTrace

public abstract class WindProfile
extends CompositeDisplayable

Provides support for the display of a vertical profile of the horizontal wind.

Version:

$Id: WindProfile.java,v 1.27 2006/11/13 16:23:51 dmurray Exp $

Author:

Steven R. Emmerson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DIRECTION The name of the wind direction property.
static java.lang.String	GEOPOTENTIAL_ALTITUDE The name of the geopotential altitude property.
static java.lang.String	GEOPOTENTIAL_ALTITUDE_EXTENT The name of the geopotential altitude extent property.
static java.lang.String	MAXIMUM_SPEED The name of the maximum wind speed property.
static java.lang.String	PRESSURE The name of the geopotential altitude property.
static java.lang.String	SPEED The name of the wind speed property.
static java.lang.String	WIND_PROFILE The name of the wind profile property.

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
protected	WindProfile() Constructs from nothing.
protected	WindProfile(WindProfile that) Constructs from another instance.

Method Summary

Modifier and Type	Method and Description
protected static visad.FlatField	ensureCartesian(visad.FlatField input) Ensures a wind profile in cartesian coordinates.
boolean	equals(java.lang.Object obj) Indicates if this instance is identical to another object.
visad.Real	getDirection() Returns the wind direction property.
visad.Real	getGeopotentialAltitude() Returns the geopotential altitude property.
visad.RealTuple	getGeopotentialAltitudeExtent() Returns the geopotential altitude extent property.
static visad.RealType	getGeopotentialAltitudeRealType() Returns the type of the geopotential altitude.
visad.Real	getMaximumSpeed() Returns the maximum wind speed property.
protected visad.FlatField	getMissingWindField() Returns an instance of a wind field with no values.
visad.Real	getPressure() Returns the pressure property.
protected abstract visad.Field	getProfile() Returns the vertical profile of the horizontal wind.
static visad.RealType	getSoutherlyWindRealType() Returns the type of the southerly wind.
visad.Real	getSpeed() Returns the wind speed property.
static visad.RealType	getWesterlyWindRealType() Returns the type of the westerly wind.
int	hashCode() Returns the hash code of this instance.
protected void	profileChange(visad.Field oldProfile) Handles a change to the vertical profile of the horizontal wind due to either explicit setting or direct manipulation by a VisAD DataRenderer.
protected void	setAltitudeExtent() Sets the vertical extent of the wind profile.
protected void	setDirection(visad.Real dir) Set the direction value
void	setGeopotentialAltitude(visad.Real geopotentialAltitude) Sets the geopotential altitude property.
protected void	setMaximumSpeed() Sets the maximum wind speed of the wind profile.
abstract void	setOriginalProfile() Resets the vertical profile of the horizontal wind to the profile of the last setProfile().
void	setPressure(visad.Real pressure) Sets the pressure property.
abstract void	setProfile(visad.Field profile) Sets the vertical profile of the horizontal wind.
protected void	setSpeed(visad.Real spd) Set the speed property
protected void	setSpeedAndDirection() Sets the wind speed and direction properties.
abstract void	setWindLevels(visad.Gridded1DSet levels) Set the levels of the wind profile to display.

Methods inherited from class ucar.visad.display.CompositeDisplayable

addConstantMap, addDisplayable, addListDataListener, clearDisplayables, cloneForDisplay, debug, destroy, destroyAll, displayableCount, fireListDataContentsChanged, fireListDataIntervalAdded, fireListDataIntervalRemoved, getAnimationSet, getDisplayable, indexOf, iterator, lastDisplayable, myAddDataReferences, myRemoveDataReferences, removeDisplayable, removeDisplayable, removeListDataListener, setAdjustFlow, setColor, setColorPalette, setColorUnit, setConstantPosition, setDisplay, 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

Field Detail

WIND_PROFILE

public static java.lang.String WIND_PROFILE

The name of the wind profile property.

GEOPOTENTIAL_ALTITUDE

public static java.lang.String GEOPOTENTIAL_ALTITUDE

The name of the geopotential altitude property.

PRESSURE

public static java.lang.String PRESSURE

The name of the geopotential altitude property.

SPEED

public static java.lang.String SPEED

The name of the wind speed property.

DIRECTION

public static java.lang.String DIRECTION

The name of the wind direction property.

GEOPOTENTIAL_ALTITUDE_EXTENT

public static java.lang.String GEOPOTENTIAL_ALTITUDE_EXTENT

The name of the geopotential altitude extent property.

MAXIMUM_SPEED

public static java.lang.String MAXIMUM_SPEED

The name of the maximum wind speed property.

Constructor Detail

WindProfile

protected WindProfile()
               throws visad.VisADException,
                      java.rmi.RemoteException

Constructs from nothing.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

WindProfile

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

Constructs from another instance.

Parameters:

that - The other instance.

Throws:

visad.VisADException - if a core VisAD failure occurs.

java.rmi.RemoteException - if a Java RMI failure occurs.

Method Detail

getMissingWindField

protected visad.FlatField getMissingWindField()

Returns an instance of a wind field with no values.

Returns:

A wind field with no values.

setProfile

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

Sets the vertical profile of the horizontal wind.

Parameters:

profile - The vertical profile of the horizontal wind.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

setOriginalProfile

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

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

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

getProfile

protected abstract visad.Field getProfile()
                                   throws visad.VisADException,
                                          java.rmi.RemoteException

Returns the vertical profile of the horizontal wind.

Returns:

The vertical profile of the horizontal wind.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

profileChange

protected void profileChange(visad.Field oldProfile)
                      throws visad.VisADException,
                             java.rmi.RemoteException

Handles a change to the vertical profile of the horizontal wind due to either explicit setting or direct manipulation by a VisAD DataRenderer.

Parameters:

oldProfile - The old profile. May be null.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

setAltitudeExtent

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

Sets the vertical extent of the wind profile.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

setMaximumSpeed

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

Sets the maximum wind speed of the wind profile.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

getMaximumSpeed

public visad.Real getMaximumSpeed()

Returns the maximum wind speed property.

Returns:

The maximum wind speed property.

getGeopotentialAltitudeExtent

public visad.RealTuple getGeopotentialAltitudeExtent()

Returns the geopotential altitude extent property.

Returns:

The geopotential altitude extent property.

setGeopotentialAltitude

public void setGeopotentialAltitude(visad.Real geopotentialAltitude)
                             throws java.rmi.RemoteException,
                                    visad.VisADException

Sets the geopotential altitude property.

Parameters:

geopotentialAltitude - The new value.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

getGeopotentialAltitude

public visad.Real getGeopotentialAltitude()

Returns the geopotential altitude property.

Returns:

The geopotential altitude property.

setPressure

public void setPressure(visad.Real pressure)
                 throws java.rmi.RemoteException,
                        visad.VisADException

Sets the pressure property.

Parameters:

pressure - The new value.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

getPressure

public visad.Real getPressure()

Returns the pressure property.

Returns:

The pressure property.

setSpeedAndDirection

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

Sets the wind speed and direction properties.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

getSpeed

public visad.Real getSpeed()

Returns the wind speed property.

Returns:

The wind speed property.

getDirection

public visad.Real getDirection()

Returns the wind direction property.

Returns:

The wind direction property.

getGeopotentialAltitudeRealType

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

Returns the type of the geopotential altitude.

Returns:

The type of the geopotential altitude.

Throws:

visad.VisADException - VisAD failure.

getWesterlyWindRealType

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

Returns the type of the westerly wind.

Returns:

The type of the westerly wind.

Throws:

visad.VisADException - VisAD failure.

getSoutherlyWindRealType

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

Returns the type of the southerly wind.

Returns:

The type of the southerly wind.

Throws:

visad.VisADException - VisAD failure.

equals

public boolean equals(java.lang.Object obj)

Indicates if this instance is identical to another object.

Overrides:

equals in class java.lang.Object

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 java.lang.Object

Returns:

The hash code of this instance.

ensureCartesian

protected static visad.FlatField ensureCartesian(visad.FlatField input)
                                          throws visad.VisADException,
                                                 java.rmi.RemoteException

Ensures a wind profile in cartesian coordinates.

Parameters:

input - Wind profile in cartesian or polar coordinates.

Returns:

Wind profile in cartesian coordinates.

Throws:

visad.VisADException - if a core VisAD failure occurs.

java.rmi.RemoteException - if a Java RMI failure occurs.

setWindLevels

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

Set the levels of the wind profile to display.

Parameters:

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

Throws:

visad.VisADException - if a core VisAD failure occurs.

java.rmi.RemoteException - if a Java RMI failure occurs.

setSpeed

protected void setSpeed(visad.Real spd)

Set the speed property

Parameters:

spd - speed value

setDirection

protected void setDirection(visad.Real dir)

Set the direction value

Parameters:

dir - direction value