faa.tg.units
Class RollAngle

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

All Implemented Interfaces:

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

public class RollAngle
extends Angle

 The RollAngle class defines the objects used to quantify the bank angle
 of an aircraft, where the right wing down is a positive roll, and the
 left wing down is a negative roll.
 (The angle vertex is on the aircraft centerline from nose to tail.)
 

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

See the source: RollAngle.java

Version:

$Id: RollAngle.java,v 3.2 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
(package private) static long	serialVersionUID
static RollAngle	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

RollAngle(double theValue, AngleUnits theUnits)
Constructor for the RollAngle class

Method Summary

RollAngle	add(RollAngle theMeasure) This summation method adds a value with like units.
boolean	eq(RollAngle theMeasure) This method provides a test for equality.
boolean	ge(RollAngle theMeasure) This method provides a test for less than / equal to.
boolean	gt(RollAngle theMeasure) This method provides a test for greater than.
boolean	le(RollAngle theMeasure) This method provides a test for greater than / equal to.
boolean	lt(RollAngle theMeasure) This method provides a test for less than.
double	ratio(RollAngle val) This division method produces a dimensionless ratio of like measures.
RollAngle	sub(RollAngle 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.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

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

ZERO

public static final RollAngle ZERO

Constructor Detail

RollAngle

public RollAngle(double theValue,
                 AngleUnits theUnits)

Constructor for the RollAngle class

Parameters:

theValue - the magnitude of RollAngle as a double

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

Method Detail

add

public RollAngle add(RollAngle 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 new RollAngle with the sum of the values.

sub

public RollAngle sub(RollAngle 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 new RollAngle with the difference of the values.

ratio

public double ratio(RollAngle val)

This division method produces a dimensionless ratio of like measures.

Returns:

the ratio of the two measures

eq

public boolean eq(RollAngle 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(RollAngle 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(RollAngle 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(RollAngle 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(RollAngle 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 Angle

Returns:

A String representing the measure in the canonical unit.

See Also:

Units