ucar.unidata.view.sounding
Class CapeBean

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

public final class CapeBean
extends ClockedBean

A Java Bean that computes the Convective Available Potential Energy (CAPE) an atmospheric buoyancy-profile.

Version:

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

Author:

Steven R. Emmerson

Field Summary

static String

OUTPUT_PROPERTY_NAME The name of the output property.

Constructor Summary

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

Method Summary

Real	getCape() Returns the value of the output CAPE property.
void	setBuoyancyProfile(Field buoy) Sets the input, buoyancy profile.

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

CapeBean

public CapeBean(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 buoy)
                        throws TypeException,
                               VisADException,
                               RemoteException

Sets the input, buoyancy profile.

Parameters:

buoy - The input, buoyancy profile.

Throws:

TypeException - if the domain quantity isn't pressure or the range quantity isn't volume per mass.

VisADException - if a VisAD failure occurs.

RemoteException - if a Java RMI failure occurs.

getCape

public Real getCape()

Returns the value of the output CAPE property. The data is not copied.

Returns:

The value of the output buoyancy-profile.