ucar.units
Class BaseUnit

java.lang.Object
  ucar.units.UnitImpl
      ucar.units.DerivedUnitImpl
          ucar.units.BaseUnit

All Implemented Interfaces:

java.io.Serializable, Base, DerivableUnit, DerivedUnit, Unit

Direct Known Subclasses:

UnknownUnit

public class BaseUnit
extends DerivedUnitImpl
implements Base

Provides support for base units.

Version:

$Id: BaseUnit.java 64 2006-07-12 22:30:50Z edavis $

Author:

Steven R. Emmerson

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ucar.units.UnitImpl

UnitImpl.MyConverter

Field Summary

Fields inherited from class ucar.units.DerivedUnitImpl

DIMENSIONLESS

Constructor Summary

protected

BaseUnit(UnitName id, BaseQuantity baseQuantity) Constructs from identifiers and a base quantity.

Method Summary

boolean	equals(java.lang.Object object) Indicates if this base unit is semantically identical to an object.
BaseQuantity	getBaseQuantity() Returns the base quantity associated with this base unit.
java.lang.String	getID() Returns the identifier for this base unit.
static BaseUnit	getOrCreate(UnitName id, BaseQuantity baseQuantity) Factory method for creating a new BaseUnit or obtaining a previously-created one.
boolean	isDimensionless() Indicates if this base unit is dimensionless.
static void	main(java.lang.String[] args) Tests this class.
java.lang.String	toString() Returns the string representation of this base unit.

Methods inherited from class ucar.units.DerivedUnitImpl

clone, fromDerivedUnit, fromDerivedUnit, fromDerivedUnit, fromDerivedUnit, getCanonicalString, getDerivedUnit, getDimension, getQuantityDimension, isCompatible, isReciprocalOf, myDivideBy, myDivideInto, myMultiplyBy, myRaiseTo, setDimension, toDerivedUnit, toDerivedUnit, toDerivedUnit, toDerivedUnit

Methods inherited from class ucar.units.UnitImpl

convertTo, convertTo, convertTo, convertTo, convertTo, convertTo, divideBy, divideInto, getConverterTo, getName, getPlural, getSymbol, getUnitName, makeLabel, multiplyBy, raiseTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface ucar.units.Unit

convertTo, convertTo, convertTo, convertTo, convertTo, convertTo, divideBy, divideInto, getConverterTo, getName, getPlural, getSymbol, getUnitName, makeLabel, multiplyBy, raiseTo

Constructor Detail

BaseUnit

protected BaseUnit(UnitName id,
                   BaseQuantity baseQuantity)
            throws NameException

Constructs from identifiers and a base quantity.

Parameters:

id - The identifiers for the base unit. id.getSymbol() shall not return null.

baseQuantity - The base quantity of the base unit.

Throws:

NameException - id.getSymbol() returned null.

Method Detail

getOrCreate

public static BaseUnit getOrCreate(UnitName id,
                                   BaseQuantity baseQuantity)
                            throws NameException,
                                   UnitExistsException

Factory method for creating a new BaseUnit or obtaining a previously-created one.

Parameters:

id - The identifier for the base unit. id.getSymbol() shall not return null.

baseQuantity - The base quantity of the base unit.

Throws:

NameException - id.getSymbol() returned null.

UnitExistsException - Attempt to incompatibly redefine an existing base unit.

getBaseQuantity

public final BaseQuantity getBaseQuantity()

Returns the base quantity associated with this base unit.

Returns:

The base quantity associated with this base unit.

getID

public final java.lang.String getID()

Returns the identifier for this base unit. This is identical to getSymbol().

Specified by:

getID in interface Base

Returns:

The identifier for this base unit.

toString

public final java.lang.String toString()

Returns the string representation of this base unit. This is identical to getID().

Specified by:

toString in interface Unit

Overrides:

toString in class DerivedUnitImpl

Returns:

The string representation of this base unit.

equals

public boolean equals(java.lang.Object object)

Indicates if this base unit is semantically identical to an object.

Specified by:

equals in interface Base

Specified by:

equals in interface Unit

Overrides:

equals in class DerivedUnitImpl

Parameters:

object - The object.

Returns:

true if and only if this base unit is semantically identical to object.

isDimensionless

public boolean isDimensionless()

Indicates if this base unit is dimensionless.

Specified by:

isDimensionless in interface Base

Specified by:

isDimensionless in interface Unit

Overrides:

isDimensionless in class DerivedUnitImpl

Returns:

true if and only if this base unit is dimensionless (e.g. "radian").

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Tests this class.

Throws:

java.lang.Exception