ucar.unidata.view.sounding
Class WindProfileSet

java.lang.Object
  extended by ucar.visad.display.Displayable
      extended by ucar.visad.display.CompositeDisplayable
          extended by ucar.unidata.view.sounding.WindProfileSet

public class WindProfileSet
extends CompositeDisplayable

Provides support for a CompositeDisplayable of WindProfile-s.

Version:
$Id: WindProfileSet.java,v 1.24 2005/05/13 18:33:42 jeffmc Exp $
Author:
Steven R. Emmerson

Field Summary
static String ACTIVE_WIND_PROFILE
          The name of the active wind profile property.
static String DIRECTION
          The name of the wind direction property.
static String GEOPOTENTIAL_ALTITUDE
          The name of the geopotential altitude property.
static String GEOPOTENTIAL_ALTITUDE_EXTENT
          The name of the geopotential altitude extent property.
static String MAXIMUM_SPEED
          The name of the maximum wind speed property.
static String PRESSURE
          The name of the pressure property.
static String SPEED
          The name of the wind speed 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
WindProfileSet(WindProfile missingWindProfile, LocalDisplay display)
          Constructs with a given missing wind profile and VisAD display.
 
Method Summary
 void addWindProfile(int index, WindProfile windProfile)
          Sets a wind profile of this composite.
 void addWindProfile(WindProfile windProfile)
          Adds a wind profile to this composite.
 void clear()
          Clears the wind profiles from this composite.
 WindProfile getActiveWindProfile()
          Returns the active wind profile property.
 Real getDirection()
          Returns the profile wind direction property.
 Real getGeopotentialAltitude()
          Returns the geopotential altitude property.
 RealTuple getGeopotentialAltitudeExtent()
          Returns the geopotential altitude extent property.
 RealType getGeopotentialAltitudeRealType()
          Returns the type of the geopotential altitude quantity.
 Real getMaximumSpeed()
          Returns the maximum profile wind speed property.
 RealType getSoutherlyWindRealType()
          Returns the type of the southerly wind quantity.
 Real getSpeed()
          Returns the profile wind speed property.
 RealType getWesterlyWindRealType()
          Returns the type of the westerly wind quantity.
 void removeWindProfile(int index)
          Removes a wind profile from this composite.
 void setActiveWindProfile(int index)
          Sets the index of the active wind-profile.
protected  void setActiveWindProfile(WindProfile profile)
          Sets the active wind profile property.
protected  void setDirection(Real dir)
          Sets the profile wind direction property.
 void setGeopotentialAltitude(Real geoAlt)
          Sets the geopotential altitude property.
protected  void setGeopotentialAltitudeExtent()
          Sets the geopotential altitude extent property.
protected  void setGeopotentialAltitudeExtent(RealTuple extent)
          Sets the geopotential altitude extent property.
protected  void setMaximumSpeed(Real speed)
          Sets the maximum profile wind speed property.
 void setOriginalProfile(int index)
          Reset the profile at the given index
 void setPressure(Real pressure)
          Sets the pressure property.
protected  void setSpeed(Real spd)
          Sets the profile wind speed property.
 void setWindLevels(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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ACTIVE_WIND_PROFILE

public static String ACTIVE_WIND_PROFILE
The name of the active wind profile property.


GEOPOTENTIAL_ALTITUDE

public static String GEOPOTENTIAL_ALTITUDE
The name of the geopotential altitude property.


PRESSURE

public static String PRESSURE
The name of the pressure property.


SPEED

public static String SPEED
The name of the wind speed property.


DIRECTION

public static String DIRECTION
The name of the wind direction property.


GEOPOTENTIAL_ALTITUDE_EXTENT

public static String GEOPOTENTIAL_ALTITUDE_EXTENT
The name of the geopotential altitude extent property.


MAXIMUM_SPEED

public static String MAXIMUM_SPEED
The name of the maximum wind speed property.

Constructor Detail

WindProfileSet

public WindProfileSet(WindProfile missingWindProfile,
                      LocalDisplay display)
               throws VisADException,
                      RemoteException
Constructs with a given missing wind profile and VisAD display.

Parameters:
missingWindProfile - The missing wind profile.
display - The VisAD display.
Throws:
VisADException - VisAD failure.
RemoteException - Java RMI failure.
Method Detail

addWindProfile

public void addWindProfile(WindProfile windProfile)
                    throws RemoteException,
                           VisADException
Adds a wind profile to this composite.

Parameters:
windProfile - The wind profile to be added.
Throws:
VisADException - VisAD failure.
RemoteException - Java RMI failure.

addWindProfile

public void addWindProfile(int index,
                           WindProfile windProfile)
                    throws RemoteException,
                           VisADException
Sets a wind profile of this composite.

Parameters:
index - The index of the wind profile.
windProfile - The wind profile value.
Throws:
VisADException - VisAD failure.
RemoteException - Java RMI failure.

removeWindProfile

public void removeWindProfile(int index)
                       throws IndexOutOfBoundsException,
                              RemoteException,
                              VisADException
Removes a wind profile from this composite.

Parameters:
index - The index of the wind profile.
Throws:
IndexOutOfBoundsException - The index is out of range.
VisADException - VisAD failure.
RemoteException - Java RMI failure.

setActiveWindProfile

public void setActiveWindProfile(int index)
                          throws RemoteException,
                                 VisADException
Sets the index of the active wind-profile.

Parameters:
index - The index of the active wind profile. A value of -1 means that there is to be no active wind profile.
Throws:
VisADException - VisAD failure.
RemoteException - Java RMI failure.

setActiveWindProfile

protected void setActiveWindProfile(WindProfile profile)
                             throws RemoteException,
                                    VisADException
Sets the active wind profile property.

Parameters:
profile - The new value.
Throws:
VisADException - VisAD failure.
RemoteException - Java RMI failure.

getActiveWindProfile

public WindProfile getActiveWindProfile()
Returns the active wind profile property.

Returns:
The active wind profile property.

setOriginalProfile

public void setOriginalProfile(int index)
                        throws VisADException,
                               RemoteException
Reset the profile at the given index

Parameters:
index - index of profile
Throws:
RemoteException - Java RMI problem
VisADException - VisAD problem

setGeopotentialAltitude

public void setGeopotentialAltitude(Real geoAlt)
                             throws RemoteException,
                                    VisADException
Sets the geopotential altitude property.

Parameters:
geoAlt - The new value.
Throws:
VisADException - VisAD failure.
RemoteException - Java RMI failure.

getGeopotentialAltitude

public Real getGeopotentialAltitude()
Returns the geopotential altitude property.

Returns:
The geopotential altitude property.

setGeopotentialAltitudeExtent

protected void setGeopotentialAltitudeExtent()
                                      throws RemoteException,
                                             VisADException
Sets the geopotential altitude extent property.

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

setGeopotentialAltitudeExtent

protected void setGeopotentialAltitudeExtent(RealTuple extent)
Sets the geopotential altitude extent property.

Parameters:
extent - The new value.

getGeopotentialAltitudeExtent

public RealTuple getGeopotentialAltitudeExtent()
Returns the geopotential altitude extent property.

Returns:
The geopotential altitude extent property.

setWindLevels

public void setWindLevels(Gridded1DSet levels)
                   throws VisADException,
                          RemoteException
Set the levels of the wind profile to display.

Parameters:
levels - the set of levels (if null, display all);
Throws:
VisADException - VisAD failure.
RemoteException - Java RMI failure.

setPressure

public void setPressure(Real pressure)
                 throws RemoteException,
                        VisADException
Sets the pressure property.

Parameters:
pressure - The pressure property.
Throws:
VisADException - VisAD failure.
RemoteException - Java RMI failure.

setSpeed

protected void setSpeed(Real spd)
Sets the profile wind speed property.

Parameters:
spd - The new value.

getSpeed

public Real getSpeed()
Returns the profile wind speed property.

Returns:
The profile wind speed property.

setDirection

protected void setDirection(Real dir)
Sets the profile wind direction property.

Parameters:
dir - The new value.

getDirection

public Real getDirection()
Returns the profile wind direction property.

Returns:
The profile wind direction property.

getGeopotentialAltitudeRealType

public RealType getGeopotentialAltitudeRealType()
                                         throws VisADException,
                                                RemoteException
Returns the type of the geopotential altitude quantity.

Returns:
The type of the geopotential altitude quantity.
Throws:
VisADException - VisAD failure.
RemoteException - Java RMI failure.

setMaximumSpeed

protected void setMaximumSpeed(Real speed)
Sets the maximum profile wind speed property.

Parameters:
speed - The new value.

getMaximumSpeed

public Real getMaximumSpeed()
Returns the maximum profile wind speed property.

Returns:
The maximum profile wind speed property.

getWesterlyWindRealType

public RealType getWesterlyWindRealType()
                                 throws VisADException,
                                        RemoteException
Returns the type of the westerly wind quantity.

Returns:
The type of the westerly wind quantity.
Throws:
VisADException - VisAD failure.
RemoteException - Java RMI failure.

getSoutherlyWindRealType

public RealType getSoutherlyWindRealType()
                                  throws VisADException,
                                         RemoteException
Returns the type of the southerly wind quantity.

Returns:
The type of the southerly wind quantity.
Throws:
VisADException - VisAD failure.
RemoteException - Java RMI failure.

clear

public void clear()
           throws VisADException,
                  RemoteException
Clears the wind profiles from this composite.

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