ucar.visad.display

Class StationModelDisplayable

java.lang.Object

ucar.visad.display.Displayable

ucar.visad.display.DisplayableData

ucar.visad.display.StationModelDisplayable

Direct Known Subclasses:

GridValueDisplayable, StationLocationDisplayable

public class StationModelDisplayable
extends DisplayableData

Class for displaying a station (layout) model plot

Author:

IDV Development Team

Nested Class Summary

Nested classes/interfaces inherited from class ucar.visad.display.DisplayableData

DisplayableData.DragAdapter

Field Summary

Fields

Modifier and Type	Field and Description
static float	OFFSET_SCALE Scale for offset

Fields inherited from class ucar.visad.display.DisplayableData

LINE_WIDTH, MANIPULABLE, renderer, VISIBLE

Fields inherited from class ucar.visad.display.Displayable

DISPLAY, parent, SCALAR_MAP_SET

Constructor Summary

Constructors

Modifier	Constructor and Description
	StationModelDisplayable() Default constructor;
	StationModelDisplayable(StationModel model) Construct a StationModelDisplayable using the specified model.
protected	StationModelDisplayable(StationModelDisplayable that) Clone constructor to create another instance.
	StationModelDisplayable(StationModel model, JythonManager jythonManager) Construct a StationModelDisplayable using the specified model.
	StationModelDisplayable(java.lang.String name) Construct a StationModelDisplayable with the specified name
	StationModelDisplayable(java.lang.String name, JythonManager jythonManager) Construct a StationModelDisplayable with the specified name
	StationModelDisplayable(java.lang.String name, StationModel stationModel) Construct a StationModelDisplayable using the specified model and name.
	StationModelDisplayable(java.lang.String name, StationModel stationModel, JythonManager jythonManager) Construct a StationModelDisplayable using the specified model and name.

Method Summary

Modifier and Type	Method and Description
Displayable	cloneForDisplay() Returns a clone of this instance suitable for another VisAD display.
protected void	destroy() Called when the displayable is removed from a display master
java.awt.Color	getColor() Get the default color
boolean	getRotateShapes() Get the RotateShapes property.
float	getScale() Get the scale of the ShapeControl.
boolean	getShouldUseAltitude() Get the ShouldUseAltitude property.
StationModel	getStationModel() Get the station model used by this displayable.
boolean	hasSelectedRange() Returns whether this Displayable has a valid range (i.e., lowSelectedRange and highSelectedRange are both not NaN's
void	setColor(java.awt.Color c) Set the color
void	setRangeForSelect(double low, double hi) Set the upper and lower limit of the range values associated with a color table.
void	setRotateShapes(boolean value) Set the RotateShapes property.
void	setScale(float newScale) Set the scale of the ShapeControl.
void	setSelectedRange(double low, double hi) Set selected range with the range for select
void	setShouldUseAltitude(boolean value) Set the ShouldUseAltitude property.
void	setStationData(visad.FieldImpl stationData) Set the station data to display using the StationModel.
void	setStationModel(StationModel model) Set the station ob model for this object
void	setStationModel(StationModel model, boolean update) Set the station ob model for this object
void	toFront() Implement toFront
boolean	writeKmzFile(java.io.File f, visad.FieldImpl data, java.lang.String name, int kmzIconWidth, int kmzIconHeight, java.awt.Color bgColor) Write the station display into a kmz file

Methods inherited from class ucar.visad.display.DisplayableData

addAction, dataChange, getActive, getAnimationSet, getData, getDataRenderer, getLineWidth, getName, getPointSize, hasData, hasDataObject, isManipulable, isPickable, myAddConstantMaps, myAddDataReferences, myRemoveDataReferences, removeAction, setActive, setData, setDataReference, setDragAdapter, setLineWidth, setManipulable, setPickable, setPointMode, setPointSize, setUseFastRendering, setVisible, showme, toString

Methods inherited from class ucar.visad.display.Displayable

addConstantMap, addConstantMaps, addDataReferences, addPropertyChangeListener, addPropertyChangeListener, addRefsInvoked, addScalarMap, addScalarMaps, applyColorUnit, applyDisplayUnit, checkUnit, combineConstantMaps, destroyDisplayable, firePropertyChange, firePropertyChange, fireScalarMapSetChange, getColorUnit, getConstantMaps, getDestroyed, 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, setUseTimesInAnimation

Methods inherited from class java.lang.Object

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

Field Detail

OFFSET_SCALE

public static final float OFFSET_SCALE

Scale for offset

See Also:

Constant Field Values

Constructor Detail

StationModelDisplayable

public StationModelDisplayable()
                        throws visad.VisADException,
                               java.rmi.RemoteException

Default constructor;

Throws:

visad.VisADException - unable to create specified VisAD objects

java.rmi.RemoteException - unable to create specified remote objects

StationModelDisplayable

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

Construct a StationModelDisplayable with the specified name

Parameters:

name - name of displayable and StationModel

Throws:

visad.VisADException - unable to create specified VisAD objects

java.rmi.RemoteException - unable to create specified remote objects

StationModelDisplayable

public StationModelDisplayable(java.lang.String name,
                               JythonManager jythonManager)
                        throws visad.VisADException,
                               java.rmi.RemoteException

Construct a StationModelDisplayable with the specified name

Parameters:

name - name of displayable and StationModel

jythonManager - The JythonManager for evaluating embedded expressions

Throws:

visad.VisADException - unable to create specified VisAD objects

java.rmi.RemoteException - unable to create specified remote objects

StationModelDisplayable

public StationModelDisplayable(StationModel model)
                        throws visad.VisADException,
                               java.rmi.RemoteException

Construct a StationModelDisplayable using the specified model.

Parameters:

model - StationModel to use for data depiction

Throws:

visad.VisADException - unable to create specified VisAD objects

java.rmi.RemoteException - unable to create specified remote objects

StationModelDisplayable

public StationModelDisplayable(StationModel model,
                               JythonManager jythonManager)
                        throws visad.VisADException,
                               java.rmi.RemoteException

Construct a StationModelDisplayable using the specified model.

Parameters:

model - StationModel to use for data depiction

jythonManager - The JythonManager for evaluating embedded expressions

Throws:

visad.VisADException - unable to create specified VisAD objects

java.rmi.RemoteException - unable to create specified remote objects

StationModelDisplayable

public StationModelDisplayable(java.lang.String name,
                               StationModel stationModel)
                        throws visad.VisADException,
                               java.rmi.RemoteException

Construct a StationModelDisplayable using the specified model and name.

Parameters:

name - name of for this displayable data reference

stationModel - StationModel to use for data depiction

Throws:

visad.VisADException - unable to create specified VisAD objects

java.rmi.RemoteException - unable to create specified remote objects

StationModelDisplayable

public StationModelDisplayable(java.lang.String name,
                               StationModel stationModel,
                               JythonManager jythonManager)
                        throws visad.VisADException,
                               java.rmi.RemoteException

Construct a StationModelDisplayable using the specified model and name.

Parameters:

name - name of for this displayable data reference

stationModel - StationModel to use for data depiction

jythonManager - The JythonManager for evaluating embedded expressions

Throws:

visad.VisADException - unable to create specified VisAD objects

java.rmi.RemoteException - unable to create specified remote objects

StationModelDisplayable

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

Clone constructor to create another instance.

Parameters:

that - object to clone from.

Throws:

java.rmi.RemoteException - a remote error

visad.VisADException - a VisAD error

Method Detail

setStationData

public void setStationData(visad.FieldImpl stationData)
                    throws visad.VisADException,
                           java.rmi.RemoteException

Set the station data to display using the StationModel.

Parameters:

stationData - Field of station observations.

Throws:

visad.VisADException - unable to create specified VisAD objects

java.rmi.RemoteException - unable to create specified remote objects

setColor

public void setColor(java.awt.Color c)
              throws visad.VisADException,
                     java.rmi.RemoteException

Set the color

Overrides:

setColor in class Displayable

Parameters:

c - the new color

Throws:

visad.VisADException - unable to create specified VisAD objects

java.rmi.RemoteException - unable to create specified remote objects

getColor

public java.awt.Color getColor()

Get the default color

Returns:

the color

toFront

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

Implement toFront

Overrides:

toFront in class Displayable

Throws:

visad.VisADException - unable to create specified VisAD objects

java.rmi.RemoteException - unable to create specified remote objects

cloneForDisplay

public Displayable cloneForDisplay()
                            throws java.rmi.RemoteException,
                                   visad.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 semi-deep clone of this instance.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

setStationModel

public void setStationModel(StationModel model)
                     throws visad.VisADException,
                            java.rmi.RemoteException

Set the station ob model for this object

Parameters:

model - StationModel to use

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

setStationModel

public void setStationModel(StationModel model,
                            boolean update)
                     throws visad.VisADException,
                            java.rmi.RemoteException

Set the station ob model for this object

Parameters:

model - StationModel to use

update - update data using new model

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

getStationModel

public StationModel getStationModel()

Get the station model used by this displayable.

Returns:

the station model

writeKmzFile

public boolean writeKmzFile(java.io.File f,
                            visad.FieldImpl data,
                            java.lang.String name,
                            int kmzIconWidth,
                            int kmzIconHeight,
                            java.awt.Color bgColor)
                     throws java.lang.Exception

Write the station display into a kmz file

Parameters:

f - The file

data - The data

name - Name for kml

kmzIconWidth - icon width

kmzIconHeight - icon height

bgColor - background color of icon

Returns:

success

Throws:

java.lang.Exception - on badness

destroy

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

Called when the displayable is removed from a display master

Overrides:

destroy in class DisplayableData

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

setScale

public void setScale(float newScale)
              throws visad.VisADException,
                     java.rmi.RemoteException

Set the scale of the ShapeControl. Usually done to set the initial scale.

Parameters:

newScale - scale to use.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

getScale

public float getScale()

Get the scale of the ShapeControl.

Returns:

current scale;

setShouldUseAltitude

public void setShouldUseAltitude(boolean value)
                          throws visad.VisADException,
                                 java.rmi.RemoteException

Set the ShouldUseAltitude property.

Parameters:

value - The new value for ShouldUseAltitude

Throws:

java.rmi.RemoteException - On badness

visad.VisADException - On badness

getShouldUseAltitude

public boolean getShouldUseAltitude()

Get the ShouldUseAltitude property.

Returns:

The ShouldUseAltitude

setSelectedRange

public void setSelectedRange(double low,
                             double hi)
                      throws visad.VisADException,
                             java.rmi.RemoteException

Set selected range with the range for select

Overrides:

setSelectedRange in class Displayable

Parameters:

low - low select value

hi - hi select value

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setRangeForSelect

public void setRangeForSelect(double low,
                              double hi)
                       throws visad.VisADException,
                              java.rmi.RemoteException

Set the upper and lower limit of the range values associated with a color table.

Parameters:

low - the minimun value

hi - the maximum value

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

hasSelectedRange

public boolean hasSelectedRange()

Returns whether this Displayable has a valid range (i.e., lowSelectedRange and highSelectedRange are both not NaN's

Returns:

true if range has been set

setRotateShapes

public void setRotateShapes(boolean value)

Set the RotateShapes property.

Parameters:

value - The new value for RotateShapes

getRotateShapes

public boolean getRotateShapes()

Get the RotateShapes property.

Returns:

The RotateShapes