faa.tg.units
Class TrueHeadingRate

java.lang.Object
  faa.tg.units.AMeasure
      faa.tg.units.AngularRate
          faa.tg.units.TrueHeadingRate

All Implemented Interfaces:

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

public class TrueHeadingRate
extends AngularRate

 TrueHeadingRate represents the object for measuring units of TrueHeadingRate

 See the source:
   TrueHeadingRate.java 
 

See section 5.6 of the Detailed Design Document for a discussion of design issues.

Version:

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

Author:

Tim Kimmet (modeled after Robert G. Oliver's Units Classes) See the source: TrueHeadingRate.java , Tim Kimmet (modeled after Robert G. Oliver's Units Classes)

See Also:

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

TrueHeadingRate(double theValue, AngularRateUnits theUnits)
Constructor for the TrueHeadingRate class

Method Summary

TrueHeadingRate	add(TrueHeadingRate theMeasure) This summation method adds a value with like units.
boolean	eq(TrueHeadingRate theMeasure) This method provides a test for equality.
boolean	ge(TrueHeadingRate theMeasure) This method provides a test for less than / equal to.
boolean	gt(TrueHeadingRate theMeasure) This method provides a test for greater than.
boolean	le(TrueHeadingRate theMeasure) This method provides a test for greater than / equal to.
boolean	lt(TrueHeadingRate theMeasure) This method provides a test for less than.
double	ratio(TrueHeadingRate val) This division method produces a dimensionless ratio of like measures.
TrueHeadingRate	sub(TrueHeadingRate theMeasure) This subtraction method subtracts a value with like units.
java.lang.String	toString() returns the String representation of this object in its original form.

Methods inherited from class faa.tg.units.AngularRate

abs, add, as, eq, ge, gt, le, lt, ratio, sub

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

TrueHeadingRate

public TrueHeadingRate(double theValue,
                       AngularRateUnits theUnits)

Constructor for the TrueHeadingRate class

Parameters:

theValue - the magnitude of TrueHeadingRate as a double

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

Method Detail

add

public TrueHeadingRate add(TrueHeadingRate 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 TrueHeadingRate sub(TrueHeadingRate 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

ratio

public double ratio(TrueHeadingRate val)

This division method produces a dimensionless ratio of like measures.

Returns:

the ratio of the two measures

eq

public boolean eq(TrueHeadingRate 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(TrueHeadingRate 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(TrueHeadingRate 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(TrueHeadingRate 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(TrueHeadingRate 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.

toString

public java.lang.String toString()

returns the String representation of this object in its original form.

Overrides:

toString in class AngularRate

Returns:

A String representing the measure in the canonical unit.

See Also:

Units