ucar.unidata.view.sounding
Class CinBean

java.lang.Object
  ucar.unidata.view.sounding.ClockedBean
      ucar.unidata.view.sounding.CinBean

public final class CinBean
extends ClockedBean

A Java Bean that computes the Convective INhibition (CIN) from a buoyancy profile, a starting pressure, and the pressure at the Level of Free Convection (LFC).

Version:

$Revision: 1.6 $ $Date: 2005/05/13 18:33:26 $

Author:

Steven R. Emmerson

Field Summary

static String

OUTPUT_PROPERTY_NAME The name of the output property.

Constructor Summary

CinBean(BeanNetwork network)
Constructs from the network in which this bean will be a component.

Method Summary

Real	getCin() Returns the value of the output Convective INhibition (CIN) property.
void	setBuoyancyProfile(Field buoyProfile) Sets the input, buoyancy profile.
void	setInitialPressure(Real initPres) Sets the initial, starting pressure.
void	setLfcPressure(Real lfcPres) Sets the pressure at the Level of Free Convection (LFC).

Methods inherited from class ucar.unidata.view.sounding.ClockedBean

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Field Detail

OUTPUT_PROPERTY_NAME

public static final String OUTPUT_PROPERTY_NAME

The name of the output property.

See Also:

Constant Field Values

Constructor Detail

CinBean

public CinBean(BeanNetwork network)

Constructs from the network in which this bean will be a component.

Parameters:

network - The bean network.

Method Detail

setBuoyancyProfile

public void setBuoyancyProfile(Field buoyProfile)
                        throws TypeException,
                               VisADException,
                               RemoteException

Sets the input, buoyancy profile. Because this bean only has one input, an immediate computation of the output property is performed. A PropertyChangeEvent is fired for the output property if it differs from the previous value.

Parameters:

buoyProfile - The input buoyancy-profile.

Throws:

TypeException - if the domain quantity of the profile isn't pressure or the range quantity of the profile isn't massic volume.

VisADException - if a VisAD failure occurs.

RemoteException - if a Java RMI failure occurs.

setInitialPressure

public void setInitialPressure(Real initPres)
                        throws TypeException,
                               VisADException,
                               RemoteException

Sets the initial, starting pressure.

Parameters:

initPres - The initial, starting pressure.

Throws:

NullPointerException - if the argument is null.

TypeException - if the pressure has the wrong type.

VisADException - if a VisAD failure occurs.

RemoteException - if a Java RMI failure occurs.

setLfcPressure

public void setLfcPressure(Real lfcPres)
                    throws TypeException,
                           VisADException,
                           RemoteException

Sets the pressure at the Level of Free Convection (LFC).

Parameters:

lfcPres - The pressure at the LFC.

Throws:

NullPointerException - if the argument is null.

TypeException - if the pressure has the wrong type.

VisADException - if a VisAD failure occurs.

RemoteException - if a Java RMI failure occurs.

getCin

public Real getCin()

Returns the value of the output Convective INhibition (CIN) property.

Returns:

The CIN value.