ReadoutProbe (McIDAS-V 1.6 Developer Documentation)

java.lang.Object
- ucar.unidata.collab.SharableImpl
- - edu.wisc.ssec.mcidasv.probes.ReadoutProbe

All Implemented Interfaces:: PropertyChangeListener, EventListener, Sharable

public class ReadoutProbe
extends SharableImpl
implements PropertyChangeListener

Field Summary

Fields
Modifier and Type	Field and Description
`private Color`	`currentColor`
`private double`	`currentLatitude`
`private double`	`currentLongitude`
`private String`	`currentValue`
`private static Color`	`DEFAULT_COLOR`
`private FlatField`	`field`
`private CopyOnWriteArrayList<ProbeListener>`	`listeners`
`private DisplayMaster`	`master`
`private static DecimalFormat`	`numFmt`
`private float`	`pointSize`
`private RealTuple`	`prevPos`
`private LineProbe`	`probe`
`static String`	`SHARE_POSITION`
`static String`	`SHARE_PROFILE`
`private static TupleType`	`TUPTYPE`
`private TextDisplayable`	`valueDisplay` Displays the value of the data at the current position.

Constructor Summary

Constructors
Constructor and Description
`ReadoutProbe(DisplayMaster master, FlatField field, Color color, String pattern, boolean visible)` Create a "HYDRA" probe that allows for displaying things like value at current position, current color, and location.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addProbeListener(ProbeListener listener)` Adds a `ProbeListener` to the listener list so that it can be notified when the probe is changed.
`private static TextDisplayable`	`createValueDisplay(Color color)`
`protected void`	`fireProbeColorChanged(Color previous, Color current)` Notifies the registered `ProbeListeners` that this probe's color has changed.
`protected void`	`fireProbeFormatPatternChanged(String previous, String current)` Notifies the registered `ProbeListeners` that this probe's location format pattern has changed.
`protected void`	`fireProbePositionChanged(RealTuple previous, RealTuple current)` Notifies the registered `ProbeListeners` that this probe's position has changed.
`protected void`	`fireProbeVisibilityChanged(boolean previous)` Notifies registered `ProbeListeners` that this probe's visibility has changed.
`Color`	`getColor()`
`float`	`getDisplayScale()` Get the scaling factor for probes and such.
`EarthLocationTuple`	`getEarthPosition()`
`String`	`getFormatPattern()` Returns the number format string current being used.
`private static RealTuple`	`getInitialLinePosition()`
`double`	`getLatitude()`
`double`	`getLongitude()`
`String`	`getValue()`
`RealTuple`	`getXYPosition()`
`void`	`handleProbeRemoval()`
`void`	`handleProbeUpdate()`
`boolean`	`hasListener(ProbeListener listener)` Determine whether or not a given `ProbeListener` is listening to the current probe.
`private static TupleType`	`makeTupleType()`
`void`	`propertyChange(PropertyChangeEvent e)` Called whenever the probe fires off a `PropertyChangeEvent`.
`void`	`quietlySetColor(Color newColor)`
`void`	`quietlySetFormatPattern(String pattern)` Update the location format pattern for the current probe, but do not fire off any events.
`void`	`quietlySetVisible(boolean visibility)`
`void`	`removeProbeListener(ProbeListener listener)` Removes a `ProbeListener` from the notification list.
`void`	`setColor(Color color)`
`private void`	`setColor(Color color, boolean quietly)` Note that if `color` is the same as `currentColor`, nothing will happen (the method exits early).
`void`	`setField(FlatField field)` Sets the `FlatField` associated with this probe to the given `field`.
`void`	`setFormatPattern(String pattern)` Update the location format pattern for the current probe.
`private void`	`setFormatPattern(String pattern, boolean quietly)` Update the location format pattern for the current probe and optionally fire off an update event.
`void`	`setLatLon(Double latitude, Double longitude)`
`void`	`setXYPosition(RealTuple position)`
`String`	`toString()` Returns a brief summary of a ReadoutProbe.
`private Tuple`	`valueAtPosition(RealTuple position, FlatField imageData)`

Methods inherited from class ucar.unidata.collab.SharableImpl
applySharableProperties, doShare, doShare, doShareExternal, doShareInternal, getReceiveShareTime, getSharablePropertiesComponent, getShareGroup, getSharing, getUniqueId, initSharable, receiveShareData, removeSharable, setReceiveShareTime, setShareGroup, setSharing, setUniqueId, showSharableDialog

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SHARE_PROFILE
```
public static final String SHARE_PROFILE
```
    See Also:
    
    Constant Field Values
  - SHARE_POSITION
```
public static final String SHARE_POSITION
```
    See Also:
    
    Constant Field Values
  - DEFAULT_COLOR
```
private static final Color DEFAULT_COLOR
```
  - TUPTYPE
```
private static final TupleType TUPTYPE
```
  - listeners
```
private final CopyOnWriteArrayList<ProbeListener> listeners
```
  - valueDisplay
```
private final TextDisplayable valueDisplay
```
    Displays the value of the data at the current position.
  - probe
```
private final LineProbe probe
```
  - master
```
private final DisplayMaster master
```
  - currentColor
```
private Color currentColor
```
  - currentValue
```
private String currentValue
```
  - currentLatitude
```
private double currentLatitude
```
  - currentLongitude
```
private double currentLongitude
```
  - pointSize
```
private float pointSize
```
  - field
```
private FlatField field
```
  - numFmt
```
private static final DecimalFormat numFmt
```
  - prevPos
```
private RealTuple prevPos
```
- Constructor Detail
  - ReadoutProbe
```
public ReadoutProbe(DisplayMaster master,
                    FlatField field,
                    Color color,
                    String pattern,
                    boolean visible)
             throws VisADException,
                    RemoteException
```
    Create a "HYDRA" probe that allows for displaying things like value at current position, current color, and location.
    Note: none of the parameters permit null values.
    
    Parameters:
    
    master - DisplayMaster containing the probe.
    
    field - Data to probe.
    
    color - Color of the probe.
    
    pattern - Format string to use with probe's location values.
    
    visible - Whether or not the probe is visible.
    
    Throws:
    
    NullPointerException - if any of the given parameters are null.
    
    VisADException - if VisAD had problems.
    
    RemoteException - if VisAD had problems.
- Method Detail
  - propertyChange
```
public void propertyChange(PropertyChangeEvent e)
```
    Called whenever the probe fires off a PropertyChangeEvent. Only handles position changes right now, all other events are discarded.
    
    Specified by:
    
    propertyChange in interface PropertyChangeListener
    
    Parameters:
    
    e - Object that describes the property change.
    
    Throws:
    
    NullPointerException - if passed a null PropertyChangeEvent.
  - setField
```
public void setField(FlatField field)
```
    Sets the FlatField associated with this probe to the given field.
    
    Parameters:
    
    field - New FlatField for this probe.
    
    Throws:
    
    NullPointerException - if passed a null field.
  - addProbeListener
```
public void addProbeListener(ProbeListener listener)
```
    Adds a ProbeListener to the listener list so that it can be notified when the probe is changed.
    
    Parameters:
    
    listener - ProbeListener to register. null listeners are not allowed.
    
    Throws:
    
    NullPointerException - if listener is null.
  - removeProbeListener
```
public void removeProbeListener(ProbeListener listener)
```
    Removes a ProbeListener from the notification list.
    
    Parameters:
    
    listener - ProbeListener to remove. null values are permitted, but since they are not allowed to be added...
  - hasListener
```
public boolean hasListener(ProbeListener listener)
```
    Determine whether or not a given ProbeListener is listening to the current probe.
    
    Parameters:
    
    listener - ProbeListener to check. null values are permitted.
    
    Returns:
    
    true if listener has been added to the list of ProbeListener objects, false otherwise.
  - fireProbePositionChanged
```
protected void fireProbePositionChanged(RealTuple previous,
                                        RealTuple current)
```
    Notifies the registered ProbeListeners that this probe's position has changed.
    
    Parameters:
    
    previous - Previous position.
    
    current - Current position.
  - fireProbeColorChanged
```
protected void fireProbeColorChanged(Color previous,
                                     Color current)
```
    Notifies the registered ProbeListeners that this probe's color has changed.
    
    Parameters:
    
    previous - Previous color.
    
    current - Current color.
  - fireProbeVisibilityChanged
```
protected void fireProbeVisibilityChanged(boolean previous)
```
    Notifies registered ProbeListeners that this probe's visibility has changed. Only takes a "previous" value, which is negated to form the "current" value.
    
    Parameters:
    
    previous - Visibility before change.
  - fireProbeFormatPatternChanged
```
protected void fireProbeFormatPatternChanged(String previous,
                                             String current)
```
    Notifies the registered ProbeListeners that this probe's location format pattern has changed.
    
    Parameters:
    
    previous - Previous location format pattern.
    
    current - Current location format pattern.
  - setColor
```
public void setColor(Color color)
```
    Parameters:
    
    color -
  - setColor
```
private void setColor(Color color,
                      boolean quietly)
```
    Note that if color is the same as currentColor, nothing will happen (the method exits early).
    
    Parameters:
    
    color - New color for this probe. Cannot be null.
    
    quietly - Whether or not to notify the list of ProbeListeners of a color change.
  - getColor
```
public Color getColor()
```
  - getValue
```
public String getValue()
```
  - getLatitude
```
public double getLatitude()
```
  - getLongitude
```
public double getLongitude()
```
  - setLatLon
```
public void setLatLon(Double latitude,
                      Double longitude)
```
  - quietlySetVisible
```
public void quietlySetVisible(boolean visibility)
```
  - quietlySetColor
```
public void quietlySetColor(Color newColor)
```
  - setFormatPattern
```
public void setFormatPattern(String pattern)
```
    Update the location format pattern for the current probe.
    
    Parameters:
    
    pattern - New location format pattern. Cannot be null.
  - quietlySetFormatPattern
```
public void quietlySetFormatPattern(String pattern)
```
    Update the location format pattern for the current probe, but do not fire off any events.
    
    Parameters:
    
    pattern - New location format pattern. Cannot be null.
  - setFormatPattern
```
private void setFormatPattern(String pattern,
                              boolean quietly)
```
    Update the location format pattern for the current probe and optionally fire off an update event.
    
    Parameters:
    
    pattern - New location format pattern. Cannot be null.
    
    quietly - Whether or not to fire a format pattern change update.
  - getFormatPattern
```
public String getFormatPattern()
```
    Returns the number format string current being used.
    
    Returns:
    
    Location format pattern string.
  - handleProbeUpdate
```
public void handleProbeUpdate()
```
  - handleProbeRemoval
```
public void handleProbeRemoval()
```
  - getDisplayScale
```
public float getDisplayScale()
```
    Get the scaling factor for probes and such. The scaling is the parameter that gets passed to TextControl.setSize() and ShapeControl.setScale().
    
    Returns:
    
    ratio of the current matrix scale factor to the saved matrix scale factor.
  - setXYPosition
```
public void setXYPosition(RealTuple position)
```
  - getXYPosition
```
public RealTuple getXYPosition()
```
  - getEarthPosition
```
public EarthLocationTuple getEarthPosition()
```
  - valueAtPosition
```
private Tuple valueAtPosition(RealTuple position,
                              FlatField imageData)
```
  - getInitialLinePosition
```
private static RealTuple getInitialLinePosition()
```
  - createValueDisplay
```
private static TextDisplayable createValueDisplay(Color color)
```
  - makeTupleType
```
private static TupleType makeTupleType()
```
  - toString
```
public String toString()
```
    Returns a brief summary of a ReadoutProbe. Please note that this format is subject to change.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String that looks like [ReadProbe@HASHCODE: color=..., latitude=..., longitude=..., value=...]

Class ReadoutProbe

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ucar.unidata.collab.SharableImpl

Methods inherited from class java.lang.Object

Field Detail

SHARE_PROFILE

SHARE_POSITION

DEFAULT_COLOR

TUPTYPE

listeners

valueDisplay

probe

master

currentColor

currentValue

currentLatitude

currentLongitude

pointSize

field

numFmt

prevPos

Constructor Detail

ReadoutProbe

Method Detail

propertyChange

setField

addProbeListener

removeProbeListener

hasListener

fireProbePositionChanged

fireProbeColorChanged

fireProbeVisibilityChanged

fireProbeFormatPatternChanged

setColor

setColor

getColor

getValue

getLatitude

getLongitude

setLatLon

quietlySetVisible

quietlySetColor

setFormatPattern

quietlySetFormatPattern

setFormatPattern

getFormatPattern

handleProbeUpdate

handleProbeRemoval

getDisplayScale

setXYPosition

getXYPosition

getEarthPosition

valueAtPosition

getInitialLinePosition

createValueDisplay

makeTupleType

toString