ucar.unidata.view.sounding
Class ParcelMode

java.lang.Object
  ucar.unidata.view.sounding.ParcelMode

All Implemented Interfaces:

XmlPersistable

public final class ParcelMode
extends Object
implements XmlPersistable

An enumerated-type for how the initial conditions (pressure, temperature, moisture content) of an air parcel is determined.

Version:

$Revision: 1.7 $ $Date: 2005/05/13 18:33:34 $

Author:

Steven R. Emmerson

Nested Class Summary

static class

ParcelMode.Factory Factory class for decoding an XML element into an instance of the enclosing class.

Field Summary

static ParcelMode	BOTTOM Compute a path for a lifted parcel whose initial conditions are based on the pressure, potential-temperature, and mixing-ratio of the sounding at maximum pressure.
static ParcelMode	LAYER Compute a path for a lifted parcel whose initial conditions are based on the mean pressure, potential-temperature, and mixing-ratio of the atmospheric layer below the input pressure.
static ParcelMode	POINT Compute a path for a lifted parcel whose initial conditions are based on the pressure and temperature of the input point and the mixing-ratio of the dew-point profile at the input pressure.
static ParcelMode	PRESSURE Compute a path for a lifted parcel whose initial conditions are based on the temperature and dew-point of the profiles at the input pressure.

Method Summary

Element	createElement(XmlEncoder encoder) Returns the XML element corresponding to this instance.
boolean	initFromXml(XmlEncoder encoder, Element elt) Returns an instance corresponding to an XML element.

Methods inherited from class java.lang.Object

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

Field Detail

POINT

public static final ParcelMode POINT

Compute a path for a lifted parcel whose initial conditions are based on the pressure and temperature of the input point and the mixing-ratio of the dew-point profile at the input pressure.

PRESSURE

public static final ParcelMode PRESSURE

Compute a path for a lifted parcel whose initial conditions are based on the temperature and dew-point of the profiles at the input pressure. This differs from POINT in that the initial temperature is taken from the temperature profile rather than the input point.

LAYER

public static final ParcelMode LAYER

Compute a path for a lifted parcel whose initial conditions are based on the mean pressure, potential-temperature, and mixing-ratio of the atmospheric layer below the input pressure.

BOTTOM

public static final ParcelMode BOTTOM

Compute a path for a lifted parcel whose initial conditions are based on the pressure, potential-temperature, and mixing-ratio of the sounding at maximum pressure. That is, the bottom of the sounding.

Method Detail

createElement

public Element createElement(XmlEncoder encoder)

Returns the XML element corresponding to this instance.

Specified by:

createElement in interface XmlPersistable

Parameters:

encoder - The XML encoder.

Returns:

The corresponding XML element.

initFromXml

public boolean initFromXml(XmlEncoder encoder,
                           Element elt)

Returns an instance corresponding to an XML element. Because this class encodes instances using the "factory" tag, this method should never be invoked.

This implementation always returns true.

Specified by:

initFromXml in interface XmlPersistable

Parameters:

encoder - The XML encoder.

elt - The XML element

Returns:

true if it is OK to do the default processing for this XML element.