faa.tg.units
Class Capacity

java.lang.Object
  faa.tg.units.AMeasure
      faa.tg.units.Capacity

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<AMeasure>

public class Capacity
extends AMeasure

 Capacity represents the object for representing the ability
 receive or contain

 

See the source: Capacity.java

Version:

$Id: Capacity.java,v 3.2 2008/08/07 19:59:02 lykensj Exp $

Author:

John Richards

See Also:

AUnits, AMeasure, Capacity, Angle, Density, Distance, Force, Mass, Pressure, Speed, Temperature, Time, Weight, Serialized Form

Field Summary

static java.lang.String	CVS_VERSION_ID The CVS Version ID
(package private) static long	serialVersionUID
static Capacity	ZERO

Fields inherited from class faa.tg.units.AMeasure

DEC0, DEC0_, DEC00, DEC000, DEC1, DEC1_, DEC12, DEC12_, DEC1L, DEC1L_, DEC2, DEC2_, DEC3, DEC3_, DEC4, DEC4_, DEC5, DEC5_, DEC6, DEC6_, DEC7, DEC7_, DEC9, DEC9_, itsValue, TIME_FRACTION

Constructor Summary

Capacity(double theValue, WeightUnits theUnits)
Constructor for the Capacity class

Method Summary

Capacity	abs() This method returns a clone that is the absolute value of this object.
Capacity	add(Capacity theMeasure) This summation method adds a value with like units.
double	as(WeightUnits theUnits) The as method extracts the value from a Measure in specified units.
boolean	eq(Capacity theMeasure) This method provides a test for equality.
boolean	ge(Capacity theMeasure) This method provides a test for less than / equal to.
boolean	gt(Capacity theMeasure) This method provides a test for greater than.
boolean	le(Capacity theMeasure) This method provides a test for greater than / equal to.
boolean	lt(Capacity theMeasure) This method provides a test for less than.
double	ratio(Capacity val) This division method produces a dimensionless ratio of like measures.
Capacity	sub(Capacity theMeasure) This subtraction method subtracts a value with like units.
java.lang.String	toString() returns the String representation of this object in the units with which it was created

Methods inherited from class faa.tg.units.AMeasure

absoluteValue, add, as, as, clone, compareTo, debug, div, eq, equals, ge, getAUnit, getCanonicalUnit, getCanonicalValue, getInitialUnit, getUnitClass, gt, hashCode, isBetween, le, lt, mul, ratio, sub, toAMeasure, toString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ZERO

public static final Capacity ZERO

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

CVS_VERSION_ID

public static final java.lang.String CVS_VERSION_ID

The CVS Version ID

See Also:

Constant Field Values

Constructor Detail

Capacity

public Capacity(double theValue,
                WeightUnits theUnits)

Constructor for the Capacity class

Parameters:

theValue - the magnitude of Capacity as a double

theUnits - the units of the value that will be stored (ex: km)

Method Detail

add

public Capacity add(Capacity theMeasure)

This summation method adds a value with like units. It overrides the method in the superclass and checks for like AMeasures as well as doing the cast for you.

Parameters:

theMeasure - the unit of measure you wish to add to this measure.

Returns:

a clone with the sum

sub

public Capacity sub(Capacity theMeasure)

This subtraction method subtracts a value with like units. It overrides the method in the superclass and checks for like AMeasures as well as doing the cast for you.

Parameters:

theMeasure - the unit of measure you wish to sub from this measure.

Returns:

a clone with the difference

abs

public Capacity abs()

This method returns a clone that is the absolute value of this object. It also does the cast for you.

Returns:

a clone with the absolute value.

ratio

public double ratio(Capacity val)

This division method produces a dimensionless ratio of like measures.

Returns:

the ratio of the two measures

eq

public boolean eq(Capacity theMeasure)

This method provides a test for equality. It overrides the method in the superclass and checks for like AMeasures as well as doing the cast for you.

Returns:

Returns boolean indicating whether values are equal.

lt

public boolean lt(Capacity theMeasure)

This method provides a test for less than. It overrides the method in the superclass and checks for like AMeasures as well as doing the cast for you.

Returns:

Returns whether this value is less than the given value.

gt

public boolean gt(Capacity theMeasure)

This method provides a test for greater than. It overrides the method in the superclass and checks for like AMeasures as well as doing the cast for you.

Returns:

Returns whether this value is greater than the given value.

ge

public boolean ge(Capacity theMeasure)

This method provides a test for less than / equal to. It overrides the method in the superclass and checks for like AMeasures as well as doing the cast for you.

Returns:

Returns result of test for less than or equal to.

le

public boolean le(Capacity theMeasure)

This method provides a test for greater than / equal to. It overrides the method in the superclass and checks for like AMeasures as well as doing the cast for you.

Returns:

Returns result of test for greater than or equal to.

as

public double as(WeightUnits theUnits)

The as method extracts the value from a Measure in specified units. Override for type safety!

Parameters:

theUnits - the units of the value that will be returned (ex: km)

Returns:

the value of the measure in specified units

toString

public java.lang.String toString()

returns the String representation of this object in the units with which it was created

Overrides:

toString in class AMeasure

Returns:

A String representing the measure in the canonical unit.

See Also:

Units