ucar.visad.quantities
Class RelativeHumidity

java.lang.Object
  extended by ucar.visad.quantities.Quantity
      extended by ucar.visad.quantities.ScalarQuantity
          extended by ucar.visad.quantities.RelativeHumidity

public class RelativeHumidity
extends ScalarQuantity

Provides support for the quantity of saturation mixing-ratio. Instances are immutable.

Version:
$Id: WaterVaporMixingRatio.java,v 1.15 2005/05/13 18:35:45 jeffmc Exp $
Author:
Steven R. Emmerson

Constructor Summary
protected RelativeHumidity(String name)
          Constructs from a name.
 
Method Summary
static Data create(Data mixingRatio, Data pressure, Data temperature)
          Creates a water-vapor mixing-ratio data object from data objects for pressure and temperature.
static RealTupleType getRealTupleType()
          Obtains the RealTupleType associated with this class.
static RealType getRealType()
          Obtains the RealType associated with this class.
 
Methods inherited from class ucar.visad.quantities.ScalarQuantity
getRealType, getRealType, realType
 
Methods inherited from class ucar.visad.quantities.Quantity
realTupleType, setRealTupleType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RelativeHumidity

protected RelativeHumidity(String name)
                    throws VisADException
Constructs from a name.

Parameters:
name - The name for the instance.
Throws:
VisADException - Couldn't create necessary VisAD object.
Method Detail

getRealType

public static RealType getRealType()
                            throws VisADException
Obtains the RealType associated with this class.

Returns:
The RealType associated with this class.
Throws:
VisADException - Couldn't perform necessary VisAD operation.

getRealTupleType

public static RealTupleType getRealTupleType()
                                      throws VisADException
Obtains the RealTupleType associated with this class.

Returns:
The RealTupleType associated with this class.
Throws:
VisADException - Couldn't perform necessary VisAD operation.

create

public static Data create(Data mixingRatio,
                          Data pressure,
                          Data temperature)
                   throws TypeException,
                          VisADException,
                          UnitException,
                          RemoteException
Creates a water-vapor mixing-ratio data object from data objects for pressure and temperature.

Parameters:
mixingRatio - The mixing ratio
pressure - The pressure data object.
temperature - The temperature data object. If the in-situ temperature is used, then the returned object is the saturation mixing ratio. If the dew-point temperature is used, then the returned object is the actual mixing-ratio.
Returns:
Water vapor mixing-ratio or saturation mixing-ratio depending on the type of temperature.
Throws:
TypeException - At least one argument has incorrect type.
UnitException - Unit conversion failure.
VisADException - Couldn't create necessary VisAD object.
RemoteException - Java RMI failure.