faa.tg.units
Class Acceleration

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

All Implemented Interfaces:

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

public class Acceleration
extends AMeasure

 Acceleration represents the object for measuring units of Acceleration

 

See the source: Acceleration.java See section 5.6 of the Detailed Design Document for a discussion of design issues.

Version:

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

Author:

Tim Kimmet (modeled after Robert G. Oliver's Units Classes)

See Also:

AUnits, AMeasure, Acceleration, 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 Acceleration	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

Acceleration(double theValue, AccelerationUnits theUnits)
Constructor for the Acceleration class

Method Summary

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

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 Acceleration 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

Acceleration

public Acceleration(double theValue,
                    AccelerationUnits theUnits)

Constructor for the Acceleration class

Parameters:

theValue - the magnitude of Acceleration as a double

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

Method Detail

add

public Acceleration add(Acceleration 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 Acceleration sub(Acceleration 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 Acceleration 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(Acceleration val)

This division method produces a dimensionless ratio of like measures.

Returns:

the ratio of the two measures

eq

public boolean eq(Acceleration 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(Acceleration 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(Acceleration 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(Acceleration 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(Acceleration 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(AccelerationUnits theUnits)

The as method extracts the value from a Measure in specified units.

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()

This method returns the String representation of this object in the units with which it was constructed.

Overrides:

toString in class AMeasure

Returns:

a pretty string with the value and the units.

See Also:

Units