ucar.unidata.idv.control
Class SoundingProfile

java.lang.Object
  ucar.visad.display.Displayable
      ucar.visad.display.DisplayableData
          ucar.visad.display.LineDrawing
              ucar.unidata.idv.control.SoundingProfile

public class SoundingProfile
extends LineDrawing

Supports a profile trace on a thermodynamic diagram.

Field Summary

static String

FIELD The name of the profile-field property.

Fields inherited from class ucar.visad.display.LineDrawing

COLOR, LINE_STYLE, LINE_WIDTH, POINT_SIZE

Fields inherited from class ucar.visad.display.DisplayableData

MANIPULABLE, VISIBLE

Fields inherited from class ucar.visad.display.Displayable

DISPLAY, parent, SCALAR_MAP_SET

Constructor Summary

protected	SoundingProfile(SoundingProfile that) Constructs from another instance.
	SoundingProfile(String name, FunctionType funcType) Constructs from a name for the displayable and a function type.

Method Summary

void	clear() Clears the profile-field.
Displayable	cloneForDisplay() Returns a clone of this instance suitable for another VisAD display.
protected void	dataChange() Handles a change to the data referenced by this instances's DataReference.
boolean	equals(Object obj) Indicates if this instance is semantically identical to another object.
Field	getProfile() Returns the profile-field property.
int	hashCode() Returns the hash code of this instance.
void	setProfile(Field field) Sets the profile field property.

Methods inherited from class ucar.visad.display.LineDrawing

getColor, getLineStyle, getLineWidth, getPointSize, setColor, setHSV, setHSV, setLineStyle, setLineWidth, setPointSize, setRGB, setRGB, setRGBA, setRGBA

Methods inherited from class ucar.visad.display.DisplayableData

addAction, destroy, getActive, getAnimationSet, getData, getDataRenderer, getName, hasData, hasDataObject, isManipulable, isPickable, myAddConstantMaps, myAddDataReferences, myRemoveDataReferences, removeAction, setActive, setData, setDataReference, setManipulable, setPickable, setPointMode, setUseFastRendering, setVisible, toString

Methods inherited from class ucar.visad.display.Displayable

addConstantMap, addConstantMaps, addDataReferences, addPropertyChangeListener, addPropertyChangeListener, addRefsInvoked, addScalarMap, addScalarMaps, applyColorUnit, applyDisplayUnit, checkUnit, combineConstantMaps, firePropertyChange, firePropertyChange, fireScalarMapSetChange, getColorUnit, getConstantMaps, getDisplay, getDisplayMaster, getDisplayUnit, getPointMode, getScalarMap, getScalarMap, getScalarMap, getScalarMapSet, getUseFastRendering, getUseTimesInAnimation, getVisible, isActive, isUnitCompatible, isVisible, logException, removeConstantMap, removeDataReferences, removePropertyChangeListener, removePropertyChangeListener, removeScalarMap, replaceScalarMap, setAdjustFlow, setColorPalette, setColorPalette, setColorUnit, setConstantPosition, setContourInfo, setDisplay, setDisplayActive, setDisplayInactive, setDisplayMaster, setDisplayUnit, setOverrideAnimationSet, setOverrideAnimationSet, setParent, setRangeForColor, setRangeForColor, setScalarMapSet, setSelectedRange, setSelectedRange, setUseTimesInAnimation, toFront

Methods inherited from class java.lang.Object

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

Field Detail

FIELD

public static final String FIELD

The name of the profile-field property.

See Also:

Constant Field Values

Constructor Detail

SoundingProfile

public SoundingProfile(String name,
                       FunctionType funcType)
                throws VisADException,
                       RemoteException

Constructs from a name for the displayable and a function type.

Parameters:

name - The name for the displayable.

funcType - The type of the profile function.

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.

SoundingProfile

protected SoundingProfile(SoundingProfile that)
                   throws RemoteException,
                          VisADException

Constructs from another instance.

Parameters:

that - The other instance.

Throws:

RemoteException

VisADException

Method Detail

setProfile

public void setProfile(Field field)
                throws TypeException,
                       RemoteException,
                       VisADException

Sets the profile field property. This method will cause a PropertyChangeEvent to be fired for the FIELD property.

Parameters:

field - The profile field property.

Throws:

TypeException - Argument has incorrect type.

VisADException - VisAD failure.

RemoteException - Java RMI failure.

getProfile

public Field getProfile()
                 throws VisADException,
                        RemoteException

Returns the profile-field property. NB: Does not return a copy.

Returns:

The profile-field property.

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.

dataChange

protected void dataChange()
                   throws VisADException,
                          RemoteException

Handles a change to the data referenced by this instances's DataReference. This method is invoked by the parent class when the data is either explicitly set or directly manipulated. This method fires a PropertyChangeEvent for the FIELD property with the Field value of the last setProfile(Field) invocation as the old value. It also causes a PropertyChangeEvent to be fired for the RANGE_VALUE property.

Overrides:

dataChange in class DisplayableData

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.

equals

public boolean equals(Object obj)

Indicates if this instance is semantically identical to another object.

Overrides:

equals in class Object

Parameters:

obj - The other object.

Returns:

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

hashCode

public int hashCode()

Returns the hash code of this instance.

Overrides:

hashCode in class Object

Returns:

The hash code of this instance.

clear

public void clear()

Clears the profile-field.

cloneForDisplay

public Displayable cloneForDisplay()
                            throws RemoteException,
                                   VisADException

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

Overrides:

cloneForDisplay in class DisplayableData

Returns:

A clone of this instance.

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.