ucar.unidata.idv.control

Class ProbeRowInfo

java.lang.Object

ucar.unidata.idv.control.ProbeRowInfo

public class ProbeRowInfo
extends java.lang.Object

Class ProbeRowInfo holds the state for each row in the probe control.

Author:

IDV Development Team

Constructor Summary

Constructors

Constructor and Description
ProbeRowInfo() ctor
ProbeRowInfo(ProbeControl control) ctor
ProbeRowInfo(ProbeControl control, DataInstance dataInstance) ctor
ProbeRowInfo(visad.Real level, visad.Real alt, int mode, visad.Unit unit, MidiProperties midiProperties) ctor used for creating a ProbeRowInfo from legacy bundles values

Method Summary

Modifier and Type	Method and Description
protected void	clearCachedSamples() Clear any cached samples
visad.Real	getAltitude() Get the Altitude property.
DataInstance	getDataInstance() Get the data instance
protected java.lang.Object	getDisplayValue() Get the DisplayValue property.
protected java.lang.String	getExtra() extra stuff for table
GridDataInstance	getGridDataInstance() Get the data instance
visad.Real	getLevel() Get the Level property.
LineState	getLineState() Get the LineState property.
MidiProperties	getMidiProperties() Get the MidiProperties property.
int	getPointIndex() Get the point index
java.lang.String	getPointParameter() Get the PointParameter property.
java.lang.String	getPointParameterName() Get the point parameter name
visad.FieldImpl	getPointSample() Get the last point sample
visad.FieldImpl	getPointSample(visad.georef.EarthLocation elt) Get the sample we last used.
protected visad.Real	getRealValue() Get the value as a Real.
protected visad.Real	getRealValue(visad.Data timeSample) Get the value at the time sample
int	getSamplingMode() Get the SamplingMode property.
java.lang.String	getStationName() Get the station name
protected visad.Data	getTimeSample() Get the time sample
protected visad.Set	getTimeSet() time set
visad.TupleType	getTupleType() Get the TupleType for the data
visad.Unit	getUnit() Get the Unit property.
visad.FieldImpl	getWorkingGrid() Get the sample we last used
protected void	initWith(ProbeRowInfo that) Sort of a copy ctor
boolean	isGrid() Are we probing on grids
boolean	isPoint() Is this for point data
protected void	playSound(double value) Play a sound for the particular row and value
void	setAltitude(visad.Real value) Set the Altitude property.
protected void	setDataInstance(DataInstance di) Set the data instance
protected void	setDisplayValue(java.lang.Object value) Set the DisplayValue property.
protected void	setExtra(java.lang.String s) extra stuff for table
void	setLevel(visad.Real value) Set the Level property.
void	setLineState(LineState value) Set the LineState property.
void	setMidiProperties(MidiProperties value) Set the MidiProperties property.
void	setPointParameter(java.lang.String value) Set the PointParameter property.
protected void	setPointSample(visad.FieldImpl sample, visad.georef.EarthLocation elt) Set the sample we last used
void	setSamplingMode(int value) Set the SamplingMode property.
void	setStationName(PointOb ob, DisplayControlImpl control) Set the station name
protected void	setTimeSample(visad.Data rt) Set the raw value from the Data.
void	setUnit(visad.Unit value) Set the Unit property.
protected void	setWorkingGrid(visad.FieldImpl grid) Set the working grid for this row
protected void	showSoundDialog(ProbeControl control) Show the sound dialog
java.lang.String	toString() to string

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProbeRowInfo

public ProbeRowInfo()

ctor

ProbeRowInfo

public ProbeRowInfo(ProbeControl control)

ctor

Parameters:

control - The control we're in. Just use it for getting the sampling mode

ProbeRowInfo

public ProbeRowInfo(visad.Real level,
                    visad.Real alt,
                    int mode,
                    visad.Unit unit,
                    MidiProperties midiProperties)

ctor used for creating a ProbeRowInfo from legacy bundles values

Parameters:

level - level

alt - altitude

mode - sampling mode

unit - display unit

midiProperties - sound configuartion

ProbeRowInfo

public ProbeRowInfo(ProbeControl control,
                    DataInstance dataInstance)

ctor

Parameters:

control - the control

dataInstance - data instance

Method Detail

isGrid

public boolean isGrid()

Are we probing on grids

Returns:

Is this data a grid

isPoint

public boolean isPoint()

Is this for point data

Returns:

true if point data

setExtra

protected void setExtra(java.lang.String s)

extra stuff for table

Parameters:

s - extra

getExtra

protected java.lang.String getExtra()

extra stuff for table

Returns:

extra

clearCachedSamples

protected void clearCachedSamples()

Clear any cached samples

setTimeSample

protected void setTimeSample(visad.Data rt)
                      throws visad.VisADException,
                             java.rmi.RemoteException

Set the raw value from the Data. If rt is null then set raw value to null. Else if rt is a RealTuple then use the first component else assume it is a Real

Parameters:

rt - The data

Throws:

java.rmi.RemoteException - On badness

visad.VisADException - On badness

getTimeSample

protected visad.Data getTimeSample()

Get the time sample

Returns:

the time sample

initWith

protected void initWith(ProbeRowInfo that)

Sort of a copy ctor

Parameters:

that - that

showSoundDialog

protected void showSoundDialog(ProbeControl control)
                        throws visad.VisADException,
                               java.rmi.RemoteException

Show the sound dialog

Parameters:

control - control I'm in

Throws:

java.rmi.RemoteException - On badness

visad.VisADException - On badness

toString

public java.lang.String toString()

to string

Overrides:

toString in class java.lang.Object

Returns:

String representation

playSound

protected void playSound(double value)

Play a sound for the particular row and value

Parameters:

value - value of data

setDisplayValue

protected void setDisplayValue(java.lang.Object value)

Set the DisplayValue property.

Parameters:

value - The new value for DisplayValue

getDisplayValue

protected java.lang.Object getDisplayValue()

Get the DisplayValue property.

Returns:

The DisplayValue

getGridDataInstance

public GridDataInstance getGridDataInstance()

Get the data instance

Returns:

The data instance

getDataInstance

public DataInstance getDataInstance()

Get the data instance

Returns:

The data instance

setDataInstance

protected void setDataInstance(DataInstance di)

Set the data instance

Parameters:

di - The data instance

getTupleType

public visad.TupleType getTupleType()
                             throws visad.VisADException,
                                    java.rmi.RemoteException

Get the TupleType for the data

Returns:

the type

Throws:

java.rmi.RemoteException - Java RMI problem

visad.VisADException - VisAD problem

getRealValue

protected visad.Real getRealValue()
                           throws visad.VisADException,
                                  java.rmi.RemoteException

Get the value as a Real. We may be a Real, if so then return. Else we may be a RealTuple. If so return the 0th component.

Returns:

My value as a Real

Throws:

java.rmi.RemoteException - On badness

visad.VisADException - On badness

getRealValue

protected visad.Real getRealValue(visad.Data timeSample)
                           throws visad.VisADException,
                                  java.rmi.RemoteException

Get the value at the time sample

Parameters:

timeSample - the time sample

Returns:

the value

Throws:

java.rmi.RemoteException - On badness

visad.VisADException - On badness

getPointParameterName

public java.lang.String getPointParameterName()
                                       throws visad.VisADException,
                                              java.rmi.RemoteException

Get the point parameter name

Returns:

the name

Throws:

java.rmi.RemoteException - On badness

visad.VisADException - On badness

getPointIndex

public int getPointIndex()
                  throws visad.VisADException,
                         java.rmi.RemoteException

Get the point index

Returns:

the index

Throws:

java.rmi.RemoteException - On badness

visad.VisADException - On badness

setUnit

public void setUnit(visad.Unit value)

Set the Unit property.

Parameters:

value - The new value for Unit

setWorkingGrid

protected void setWorkingGrid(visad.FieldImpl grid)

Set the working grid for this row

Parameters:

grid -

getWorkingGrid

public visad.FieldImpl getWorkingGrid()

Get the sample we last used

Returns:

sample

setPointSample

protected void setPointSample(visad.FieldImpl sample,
                              visad.georef.EarthLocation elt)
                       throws visad.VisADException,
                              java.rmi.RemoteException

Set the sample we last used

Parameters:

sample - sample

elt - The point we sampled on

Throws:

java.rmi.RemoteException - On badness

visad.VisADException - On badness

setStationName

public void setStationName(PointOb ob,
                           DisplayControlImpl control)
                    throws visad.VisADException,
                           java.rmi.RemoteException

Set the station name

Parameters:

ob - the point observation

control - The display control this is part of

Throws:

java.rmi.RemoteException - On badness

visad.VisADException - On badness

getTimeSet

protected visad.Set getTimeSet()
                        throws visad.VisADException,
                               java.rmi.RemoteException

time set

Returns:

time set

Throws:

java.rmi.RemoteException - On badness

visad.VisADException - On badness

getPointSample

public visad.FieldImpl getPointSample()

Get the last point sample

Returns:

Point sample

getPointSample

public visad.FieldImpl getPointSample(visad.georef.EarthLocation elt)

Get the sample we last used. If The given earth location is not the same as the location of the last point we sampled on then null out the sample and return null.

Parameters:

elt - The point we want to sample on

Returns:

sample

getUnit

public visad.Unit getUnit()

Get the Unit property.

Returns:

The Unit

setLevel

public void setLevel(visad.Real value)

Set the Level property.

Parameters:

value - The new value for Level

getLevel

public visad.Real getLevel()

Get the Level property.

Returns:

The Level

setAltitude

public void setAltitude(visad.Real value)

Set the Altitude property.

Parameters:

value - The new value for Altitude

getAltitude

public visad.Real getAltitude()

Get the Altitude property.

Returns:

The Altitude

setSamplingMode

public void setSamplingMode(int value)

Set the SamplingMode property.

Parameters:

value - The new value for SamplingMode

getSamplingMode

public int getSamplingMode()

Get the SamplingMode property.

Returns:

The SamplingMode

setMidiProperties

public void setMidiProperties(MidiProperties value)

Set the MidiProperties property.

Parameters:

value - The new value for MidiProperties

getMidiProperties

public MidiProperties getMidiProperties()

Get the MidiProperties property.

Returns:

The MidiProperties

setLineState

public void setLineState(LineState value)

Set the LineState property.

Parameters:

value - The new value for LineState

getLineState

public LineState getLineState()

Get the LineState property.

Returns:

The LineState

getStationName

public java.lang.String getStationName()

Get the station name

Returns:

the name or null

setPointParameter

public void setPointParameter(java.lang.String value)

Set the PointParameter property.

Parameters:

value - The new value for PointParameter

getPointParameter

public java.lang.String getPointParameter()

Get the PointParameter property.

Returns:

The PointParameter