faa.tg.units
Class FlightPathAngle

java.lang.Object
  faa.tg.units.AMeasure
      faa.tg.units.Angle
          faa.tg.units.FlightPathAngle

All Implemented Interfaces:

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

Direct Known Subclasses:

FlightPathRelAirAngle

public class FlightPathAngle
extends Angle

 FlightPathAngle represents the object for measuring the angle between the
 aircraft's velocity vector and the plane that is tangent to the surface
 of the Earth directly under the aircraft.
 

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

See the source: FlightPathAngle.java

Version:

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

Author:

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

See Also:

AUnits, AMeasure, Units.rad, Serialized Form

Field Summary

static java.lang.String	CVS_VERSION_ID The CVS Version ID
static FlightPathAngle	FIVE_DEG
private boolean	objCreatedAfter2005_09_29
(package private) static long	serialVersionUID
static FlightPathAngle	TWOPTFIVE_DEG
static FlightPathAngle	ZERO

Fields inherited from class faa.tg.units.Angle

D180_DIV_PI, DEG_1, DEG_180, DEG_270, DEG_30, DEG_330, DEG_5, DEG_60, DEG_90, DEG_NEG180, DEG_NEG270, DEG_NEG30, DEG_NEG5, DEG_NEG90, DEG_PER_RAD, NEG_NINETY_DEG, NEG_ONEEIGHTY_DEG, NINETY_DEG, ONEEIGHTY_DEG, PI, PI_DIV_180, PI_DIV_2, PI_DIV_4, PI_MUL_2, PI_MUL_4, RAD_PER_DEG, THIRTY_DEG, THREETHIRTY_DEG, TWOSEVENTY_DEG

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

FlightPathAngle(double theValue, AngleUnits theUnits)
Constructs a FlightPathAngle: a measure of the angle between the velocity vector of an aircraft and the plane that is tangent to the surface of the Earth directly under the aircraft.

Method Summary

FlightPathAngle	add(FlightPathAngle addend) This summation method adds a value with like units.
FlightPathAngle	average(FlightPathAngle fpa) This summation method averages two values with like units.
boolean	eq(FlightPathAngle theMeasure) This method provides a test for equality.
boolean	ge(FlightPathAngle theMeasure) This method provides a test for less than / equal to.
boolean	gt(FlightPathAngle theMeasure) This method provides a test for greater than.
boolean	le(FlightPathAngle theMeasure) This method provides a test for greater than / equal to.
boolean	lt(FlightPathAngle theMeasure) This method provides a test for less than.
static double	normalizeRange(double value, AUnits units) Normalizes the FlightPathAngle to be in the range: -180 < value <= 180.
double	ratio(FlightPathAngle val) This division method produces a dimensionless ratio of like measures.
FlightPathAngle	sub(FlightPathAngle theMeasure) This subtraction method subtracts a value with like units.
Longitude	sub(Longitude subtrahend) Returns the difference of this value and the parameter's value.
java.lang.String	toString() returns the String representation of this object in the form with which it was created.
FlightPathAngle	toValidatedObjectType() Return this as the correct type.

Methods inherited from class faa.tg.units.Angle

abs, add, aeq, as, average, cos, diff, eq, ge, gt, isBetween, le, lt, main, parseDmsString, ratio, reciprocalAngle, removeDelimiters, sin, sub, tan, toDmsString, toRadialString, toText

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 FlightPathAngle ZERO

FIVE_DEG

public static final FlightPathAngle FIVE_DEG

TWOPTFIVE_DEG

public static final FlightPathAngle TWOPTFIVE_DEG

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

objCreatedAfter2005_09_29

private final boolean objCreatedAfter2005_09_29

Constructor Detail

FlightPathAngle

public FlightPathAngle(double theValue,
                       AngleUnits theUnits)

Constructs a FlightPathAngle: a measure of the angle between the velocity vector of an aircraft and the plane that is tangent to the surface of the Earth directly under the aircraft.

Parameters:

theValue - The magnitude of the FlightPathAngle as a double.

theUnits - Units of the value to be stored (ex: radians).

Method Detail

normalizeRange

public static double normalizeRange(double value,
                                    AUnits units)

Normalizes the FlightPathAngle to be in the range: -180 < value <= 180. In degrees: (180 + 1) is -179, and (-179.99 - 1) is 179.01.

toValidatedObjectType

public FlightPathAngle toValidatedObjectType()

Return this as the correct type. Returns this object unless this object was deserialized from a recording made before 2005-09-30: the types used to be equivalent since there was no wind, but now most of TGF requires a FlightPathRelAirAngle.

add

public FlightPathAngle add(FlightPathAngle addend)

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:

addend - The unit of measure to add to this measure.

Returns:

A new FlightPathAngle equal to this value plus parameter value.

sub

public Longitude sub(Longitude subtrahend)

Returns the difference of this value and the parameter's value. 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:

subtrahend - The longitude to subtract from this measure.

Returns:

A new Longitude equal to this value minus the parameter value.

average

public FlightPathAngle average(FlightPathAngle fpa)

This summation method averages two values with like units. It overrides the method in the superclass and checks for like AMeasures as well as doing the cast for you.

Parameters:

fpa - Unit of measure you wish to average with this measure.

Returns:

A new FlightPathAngle with the average of the values.

sub

public FlightPathAngle sub(FlightPathAngle 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 - Unit of measure to subtract from this measure.

Returns:

A new FlightPathAngle with the difference of the values.

ratio

public double ratio(FlightPathAngle val)

This division method produces a dimensionless ratio of like measures.

Returns:

the ratio of the two measures

eq

public boolean eq(FlightPathAngle 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(FlightPathAngle 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(FlightPathAngle 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(FlightPathAngle 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(FlightPathAngle 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 the form with which it was created.

Overrides:

toString in class Angle

Returns:

A String representing the measure in the canonical unit.

See Also:

Units