faa.tg.pointmodel
Class PositionRate

java.lang.Object
  faa.tg.pointmodel.PositionRate

All Implemented Interfaces:

Immutable, java.io.Serializable

public class PositionRate
extends java.lang.Object
implements java.io.Serializable, Immutable

 The PositionRate object encapsulates three rates to describe the rate of
 position change: LatitudeRate, LongitudeRate and AltitudeRate.
 

See the source: PositionRate.java

Version:

$Id: PositionRate.java,v 3.3 2008/08/07 20:11:55 lykensj Exp $

Author:

Tim Kimmet

See Also:

Serialized Form

Field Summary

private AltitudeRate	altitudeRate Altitude is the feet above mean sea level on the earth.
static java.lang.String	CVS_VERSION_ID The CVS Version ID
private LatitudeRate	latitudeRate Latitude is the geodetic latitude location on the earth.
private LongitudeRate	longitudeRate Longitude is the geodetic longitude location on the earth.
(package private) static long	serialVersionUID

Constructor Summary

PositionRate(LatitudeRate latRate, LongitudeRate longRate, AltitudeRate altRate)
PositionRate constructor that takes a LatitudeRate, a LongitudeRate, and an AltitudeRate.

PositionRate(Position pos, NED_VelocityVector velVectorNED)
Method to calculate the position rate of the Aircraft from a Position and an NED_VelocityVector.

Method Summary

private LatitudeRate	calcLatRate(Position pos, Speed velocityX, PropagationTerms propTerms) Calculates the rate of change of a latitude, given a Position, an x-component velocity, and propagation terms.
private LongitudeRate	calcLonRate(Position pos, Speed velocityY, PropagationTerms propTerms) Calculates the rate of change of a longitude, given a Position, an x-component velocity, and propagation terms.
AltitudeRate	getAltitudeRate() Return the AltitudeRate component of this PositionRate.
LatitudeRate	getLatitudeRate() Return the LatitudeRate component of this PositionRate.
LongitudeRate	getLongitudeRate() Return the LongitudeRate component of this PositionRate.
java.lang.String	toDraText() Return the output text String representation of this object.
java.lang.String	toString() Return the String representation of this object StringBuffer is used for efficiency.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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

latitudeRate

private LatitudeRate latitudeRate

Latitude is the geodetic latitude location on the earth.

longitudeRate

private LongitudeRate longitudeRate

Longitude is the geodetic longitude location on the earth.

altitudeRate

private AltitudeRate altitudeRate

Altitude is the feet above mean sea level on the earth.

Constructor Detail

PositionRate

public PositionRate(LatitudeRate latRate,
                    LongitudeRate longRate,
                    AltitudeRate altRate)

PositionRate constructor that takes a LatitudeRate, a LongitudeRate, and an AltitudeRate.

PositionRate

public PositionRate(Position pos,
                    NED_VelocityVector velVectorNED)

Method to calculate the position rate of the Aircraft from a Position and an NED_VelocityVector.

Parameters:

pos - The position of the aircraft.

velVectorNED - The velocity vector in a North-East-Down frame.

Method Detail

calcLatRate

private LatitudeRate calcLatRate(Position pos,
                                 Speed velocityX,
                                 PropagationTerms propTerms)

Calculates the rate of change of a latitude, given a Position, an x-component velocity, and propagation terms.

Parameters:

pos - The position to start from.

velocityX - The x-component of the velocity vector.

propTerms - The terms for trajectory propagation calculations.

Returns:

the latitude's rate of change as a LatitudeRate.

calcLonRate

private LongitudeRate calcLonRate(Position pos,
                                  Speed velocityY,
                                  PropagationTerms propTerms)

Calculates the rate of change of a longitude, given a Position, an x-component velocity, and propagation terms.

Parameters:

pos - The position to start from.

velocityY - The y-component of the velocity vector.

propTerms - The terms for trajectory propagation calculations.

Returns:

the longitude's rate of change as a LongitudeRate.

getAltitudeRate

public AltitudeRate getAltitudeRate()

Return the AltitudeRate component of this PositionRate.

getLatitudeRate

public LatitudeRate getLatitudeRate()

Return the LatitudeRate component of this PositionRate.

getLongitudeRate

public LongitudeRate getLongitudeRate()

Return the LongitudeRate component of this PositionRate.

toDraText

public java.lang.String toDraText()

Return the output text String representation of this object. StringBuffer is used for efficiency.

Returns:

The String representation of this Object.

toString

public java.lang.String toString()

Return the String representation of this object StringBuffer is used for efficiency.

Overrides:

toString in class java.lang.Object

Returns:

the String representation of this Object.