ucar.units
Class SupplementaryBaseQuantity

java.lang.Object
  extended by ucar.units.BaseQuantity
      extended by ucar.units.SupplementaryBaseQuantity
All Implemented Interfaces:
Serializable, Comparable<BaseQuantity>, Base

public final class SupplementaryBaseQuantity
extends BaseQuantity

Provides support for supplementary base quantities. A supplementary base quantity is one that is dimensionless (e.g. solid angle). Instances of this class are immutable.

Version:
$Id: SupplementaryBaseQuantity.java 64 2006-07-12 22:30:50Z edavis $
Author:
Steven R. Emmerson
See Also:
Serialized Form

Field Summary
 
Fields inherited from class ucar.units.BaseQuantity
AMOUNT_OF_SUBSTANCE, ELECTRIC_CURRENT, LENGTH, LUMINOUS_INTENSITY, MASS, PLANE_ANGLE, SOLID_ANGLE, THERMODYNAMIC_TEMPERATURE, TIME, UNKNOWN
 
Constructor Summary
  SupplementaryBaseQuantity(String name, String symbol)
          Constructs from a name and symbol.
protected SupplementaryBaseQuantity(String name, String symbol, boolean trusted)
          Constructs from a name and symbol.
 
Method Summary
 boolean isDimensionless()
          Indicates whether or not this quantity is dimensionless.
 
Methods inherited from class ucar.units.BaseQuantity
compareTo, equals, getID, getName, getSymbol, hashCode, main, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SupplementaryBaseQuantity

public SupplementaryBaseQuantity(String name,
                                 String symbol)
                          throws NameException
Constructs from a name and symbol.

Parameters:
name - The name of the quantity.
symbol - The symbol for the quantity.
Throws:
NameException - Bad quantity name.

SupplementaryBaseQuantity

protected SupplementaryBaseQuantity(String name,
                                    String symbol,
                                    boolean trusted)
Constructs from a name and symbol. This is a trusted constructor for use by the superclass only.

Parameters:
name - The name of the quantity.
symbol - The symbol for the quantity.
Method Detail

isDimensionless

public boolean isDimensionless()
Indicates whether or not this quantity is dimensionless. Supplementary base quantities are dimensionless by definition.

Specified by:
isDimensionless in interface Base
Specified by:
isDimensionless in class BaseQuantity
Returns:
true.


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.