faa.tg.recording.state
Class AircraftState

java.lang.Object
  extended by faa.tg.recording.state.State
      extended by faa.tg.recording.state.AircraftState
All Implemented Interfaces:
DelimWritable, DraStorable, Flyable, HasTextXY, Landable, Separable, SimComparable, TextWritable, HasAcid, HasArrRwy, HasBeaconCode, HasDepRwy, HasFlyingStatus, HasFrequency, HasName, HasPosition, HasSector, HasSimTime, HasTrueHeading, HasWeightClass, Movable, Filterable, Recordable, ManagedObject, java.io.Serializable, java.lang.Cloneable

public class AircraftState
extends State
implements DraStorable, HasAcid, HasDepRwy, HasBeaconCode, HasFrequency, HasSector, Separable, SimComparable, TextWritable, HasTextXY, DelimWritable

 The recordable state of the Aircraft object.
 
See the source AircraftState.java

Version:
$Id: AircraftState.java,v 3.38 2009/01/27 19:56:25 lonnies Exp $
Author:
David M. D'Auria
See Also:
Aircraft, AircraftState, Recordable, Serialized Form

Field Summary
private  Acid acid
           
private  AcType acType
          This aircraft type is the scenario equivalent: for the aircraft type as specified in the flight plan, get the AcType from Flight(State).
private  java.lang.String airLine
           
private  AltitudeRate altRate
           
private  Distance altRestrictionDist
          Distance to next route restriction, or null if no route restrictions.
private  AirportRwyID arrRwy
           
private  java.lang.Boolean cleared
           
private  Coefficient coeffOfLift
           
private  java.lang.String currentRouteString
           
private  java.lang.String currentRouteStrWithBracket
           
private  java.lang.String currManeuverString
           
static java.lang.String CVS_VERSION_ID
          The CVS Version ID
private  AirportRwyID depRwy
           
private  Altitude desiredAltitude
           
private  Frequency desiredFreq
           
private  TrueHeading desiredHeading
           
private  IndicatedAirspeed desiredIAS
           
private  Mach desiredMach
           
private  MagneticHeading desiredMagHeading
           
private  RollAngle desiredRollAngle
           
private  Drag drag
           
private  Coefficient dragCoefficient
           
private  java.lang.String dynamicsTypeString
           
private  java.lang.String engineClass
           
private  java.lang.String filedRouteString
           
private  FlapSetting flapSetting
          FlapSetting field retained for backward compatibility: for recordings from TGF versions prior to 2006/06/29.
private  java.lang.String flapSettingStr
          Flap setting (as a String) of the aircraft during this second.
private  FlightPathAngle flightPathAngle
           
private  FlyingStatus flyingStatus
           
private  Frequency freq
           
private  GeoSector geoSector
           
private  Distance groundTrack
           
private  GroundTrackHeading groundTrackHeading
           
private  GroundTrackSpeed groundTrackSpeed
           
private  java.lang.String groupInfo
           
private  TrueHeading heading
           
private  IndicatedAirspeed ias
           
private  java.lang.Boolean isDataEquipped
           
private  java.lang.Boolean landingGearDeployed
           
private  java.lang.String lateralManeuverString
           
private  Mach mach
           
static java.text.DecimalFormat MACH_TEXT
          Mach text for up to 2 decimal places, formatted as: " Mach: .0#"
private  MagneticHeading magneticHeading
           
private static MethodMap methodMap
          Map of delimWritable methods as MethodSpec objects.
private  Altitude modusAlt
           
private  AltitudeRate modusAltRate
           
private  IndicatedAirspeed modusIas
           
private  Mach modusMach
           
private  java.lang.String navEquip
           
private static java.lang.String NO_ALT_RESTR_TEXT
           
private  Position pos
           
private  java.lang.String regionName
           
private  RouteNode restrRouteNode
          Route with restrictions that affect the longitudinal maneuvers (decision points are at route nodes): null means route has no route restrictions.
private  RollAngle rollAngle
           
private  Distance routeRemainDist
           
private  Sector sector
           
(package private) static long serialVersionUID
           
static SimCompareCriteria SIM_COMPARE_CRITERIA
          The criteria used to compare AircraftStates to see if they match.
private  SimulationTime simTime
          The SimulationTime of this snapshot of the aircraft's state.
private  java.lang.Boolean speedBrakesOn
           
private  java.lang.Object spID
           
private  SimulationTime startTime
           
private  TrueAirspeed tas
           
private  Thrust thrust
           
private  Transponder transponder
           
private  TurnRate turnRate
           
private  AcType ufpAcType
          This aircraft type is the actual aircraft type from the flight plan.
private  AircraftWeight weight
           
private  WeightClass weightClass
           
 
Constructor Summary
AircraftState(double simTime)
          Constructor for the aircraft state that specifies the specific second of simulation time that the aircraft data refers to.
AircraftState(SimulationTime simTime)
           
 
Method Summary
 java.lang.Object clone()
           
 Acid getAcid()
          Planned change of String ACID to type Acid.
 AcType getAcType()
          Returns the type of aircraft: this is the scenario's type equivalent: NOT NECESSARILY the aircraft type from the flight plan or the type generated by the standard DR&A output.
 AircraftWeight getAircraftWeight()
           
 java.lang.String getAirLine()
           
 Altitude getAltitude()
           
 AltitudeRate getAltRate()
           
 Distance getAltRestrictionDist()
           
 AirportRwyID getArrRwy()
          This will soon be deprecated.
 BeaconCode getBeaconCode()
           
 Coefficient getCoeffOfLift()
           
 java.lang.String getCurrentManeuver()
           
 java.lang.String getCurrentRoute()
          Returns the current route as a String.
 java.lang.String getCurrentRouteWithBracketLogic()
           
 AirportRwyID getDepRwy()
          This will soon be deprecated.
 Altitude getDesiredAltitude()
           
 Frequency getDesiredFrequency()
           
 TrueHeading getDesiredHeading()
           
 IndicatedAirspeed getDesiredIndicatedAirspeed()
           
 Mach getDesiredMach()
           
 MagneticHeading getDesiredMagneticHeading()
           
 RollAngle getDesiredRollAngle()
           
 Drag getDrag()
           
 Coefficient getDragCoefficient()
           
 java.lang.String getDynamicsType()
           
 java.lang.String getEngineClass()
           
 java.lang.String getFiledRouteString()
           
 java.lang.String getFlapSetting()
           
 FlightPathAngle getFlightPathAngle()
           
 FlyingStatus getFlyingStatus()
          Returns the flying state of the aircraft.
 Frequency getFrequency()
           
 GeoSector getGeoSector()
           
 Distance getGroundTrack()
           
 GroundTrackHeading getGroundTrackHeading()
           
 GroundTrackSpeed getGroundTrackSpeed()
           
 java.lang.String getGroupInfo()
           
 IndicatedAirspeed getIndicatedAirspeed()
           
 java.lang.Boolean getIsClearedForTakeOff()
           
 java.lang.String getLateralManeuverString()
           
 Latitude getLatitude()
           
 Longitude getLongitude()
           
 Mach getMach()
           
 MagneticHeading getMagneticHeading()
           
 MethodMap getMethodMap()
          Returns the AircraftState information in DelimWritable format.
 Altitude getModusAlt()
          Return the modus value for the altitude.
 AltitudeRate getModusAltRate()
          Return the modus value for the altitude rate.
 IndicatedAirspeed getModusIas()
          Return the modus value for the indicated airspeed.
 Mach getModusMach()
          Return the modus value for the speed in Mach.
 java.lang.String getName()
          Returns ACID; if used as a storage key, old AircraftStates will be replaced by new AircraftStates each second.
 java.lang.String getNavEquip()
           
 Position getPosition()
           
 java.lang.String getRegionName()
           
 java.lang.String getRestrictionString()
          Return a String with info on the next altitude restriction: string is empty ("") if there is no altitude restriction on the route.
 RouteNode getRestrRouteNode()
           
 RollAngle getRollAngle()
           
 Distance getRouteRemainDist()
           
 java.lang.String getRouteString()
           
 Sector getSector()
           
 SimCompareCriteria getSimCompareCriteria()
          Returns the SimCompareCriteria used for AircraftState objects, used to compare AircraftStates across simulations to see if the sims match.
 SimulationTime getSimTime()
          Returns the SimulationTime corresponding to the aircraft state values.
 java.lang.String getSpdAltManeuverString()
           
 SpID getSpID()
          Gets the ID of the SimPilotStation that this is assigned to.
 SimulationTime getStartTime()
           
 Thrust getThrust()
           
 Weight getTotalWeight()
          Return the total weight of the aircraft as a Weight.
 Transponder getTransponder()
           
 TrueAirspeed getTrueAirspeed()
           
 TrueHeading getTrueHeading()
           
 TurnRate getTurnRate()
           
static ListSelectable[] getTypeList()
          Returns certain slow-to-change fields as a ListSelectable array of MethodSpecSelectable objects.
 AcType getUfpAcType()
          Returns the type of aircraft specified in the FLIGHT PLAN (getAcType() returns the aircraft type equivalent used by the scenario).
 WeightClass getWeightClass()
           
 boolean isDatalinkEquipped()
           
 java.lang.Boolean isLandingGearDeployed()
           
 java.lang.Boolean isSpeedBrakesOn()
           
private static MethodMap makeMethodMap()
          Creates the MethodMap of field names and MethodSpecs.
private  void readObject(java.io.ObjectInputStream in)
          Set Sector (and Frequency) if not defined and if DraStore is active.
private  void readObjectConciseVersion(java.io.ObjectInputStream in)
           
 void setAcid(Acid acid)
          Sets the aircraft ID (ACID) identifying the aircraft.
 void setAcType(AcType acType)
          Set the type of aircraft: this is the scenario's type equivalent: NOT NECESSARILY the aircraft type from the flight plan.
 void setAcType(java.lang.String acType)
          Set the type of aircraft: this is the scenario's type equivalent: NOT NECESSARILY the aircraft type from the flight plan.
 void setAircraftWeight(AircraftWeight weight)
           
 void setAirLine(java.lang.String airLine)
           
 void setAltRate(AltitudeRate altRate)
           
 void setAltRestrictionDist(Distance altRestrictionDist)
           
 void setArrRwy(AirportRwyID arrRwy)
           
 void setCoeffOfLift(Coefficient coeffOfLift)
           
 void setCurrentFlapSetting(FlapSetting flapSetting)
           
 void setCurrentManeuver(java.lang.String aName)
           
 void setDepRwy(AirportRwyID depRwy)
           
 void setDesiredAltitude(Altitude desiredAltitude)
           
 void setDesiredFrequency(Frequency desiredFrequency)
           
 void setDesiredHeading(TrueHeading desiredHeading)
           
 void setDesiredIndicatedAirspeed(IndicatedAirspeed desiredIAS)
           
 void setDesiredMach(Mach desiredMach)
           
 void setDesiredMagneticHeading(MagneticHeading desiredMagHeading)
           
 void setDesiredRollAngle(RollAngle desiredRollAngle)
           
 void setDrag(Drag drag)
           
 void setDragCoefficient(Coefficient dragCoefficient)
           
 void setDynamicsType(java.lang.String currentDynamics)
           
 void setEngineClass(java.lang.String engineClass)
           
 void setFiledRouteString(java.lang.String filedRouteString)
           
 void setFlightPathAngle(FlightPathAngle flightPathAngle)
           
 void setFlyingStatus(FlyingStatus flyingStatus)
           
 void setFrequency(Frequency frequency)
           
 void setGeoSector(GeoSector geoSector)
           
 void setGroundTrack(Distance distanceTravelled)
          Updates the distance travelled since the aircraft start.
 void setGroundTrackHeading(GroundTrackHeading groundTrackHeading)
           
 void setGroundTrackSpeed(GroundTrackSpeed groundTrackSpeed)
           
 void setGroupInfo(java.lang.String groupInfo)
           
 void setIndicatedAirspeed(IndicatedAirspeed ias)
           
 void setIsClearedForTakeOff(java.lang.Boolean cleared)
           
 void setIsDatalinkEquipped(boolean value)
           
 void setLandingGearDeployed(java.lang.Boolean isDeployed)
           
 void setLateralManeuverString(java.lang.String latGuidanceManeuver)
           
 void setMach(Mach mach)
           
 void setMagneticHeading(MagneticHeading magneticHeading)
           
 void setModusResult(ModusResult modusResult)
          Set the modus values using a ModusResult.
 void setNavEquip(java.lang.String navEquip)
           
 void setPosition(Position pos)
           
 void setRegionName(java.lang.String regionName)
          Sets region name; only needed if setModusResult() is not called.
 void setRestrRouteNode(RouteNode restrRouteNode)
           
 void setRollAngle(RollAngle rollAngle)
           
 void setRouteRemainDist(Distance routeRemainDist)
           
 void setRouteString(java.lang.String currentRouteString)
           
 void setRouteWithBracketLogicString(java.lang.String currentRouteStrWithBracket)
           
 void setSector(Sector sector)
           
 void setSimTime(SimulationTime aSimTime)
           
 void setSpdAltManeuver(SpdAltManeuver spdAltManeuver)
           
 void setSpdAltManeuver(java.lang.String spdAltManeuverStr)
           
 void setSpeedBrakesOn(java.lang.Boolean isOn)
           
 void setSpID(SpID spID)
          Sets the ID of the SimPilotStation that this is assigned to.
 void setStartTime(SimulationTime startTime)
           
 void setThrust(Thrust thrust)
           
 void setTransponder(Transponder transponder)
           
 void setTrueAirspeed(TrueAirspeed tas)
           
 void setTrueHeading(TrueHeading heading)
           
 void setTurnRate(TurnRate turnRate)
           
 void setUfpAcType(AcType ufpAcType)
          Set the actual aircraft type from the flight plan: standard aircraft type output for DR&A.
 void setWeightClass(WeightClass weightClass)
           
 java.lang.String toDraText()
          Returns the AircraftState information as a DR&A text String (contains location in latitude/longitude).
 java.lang.String toDraText(MapProjection projection, DistanceUnits dUnits)
          Returns the AircraftState information as a DR&A text String: if the parameter passed is TRUE, then text contains xy-coordinates to describe the location instead of latitude/longitude.
 java.lang.String toString()
          Prints the AircraftState information to a String.
 
Methods inherited from class java.lang.Object
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

SIM_COMPARE_CRITERIA

public static final SimCompareCriteria SIM_COMPARE_CRITERIA
The criteria used to compare AircraftStates to see if they match.


MACH_TEXT

public static final java.text.DecimalFormat MACH_TEXT
Mach text for up to 2 decimal places, formatted as: " Mach: .0#"


NO_ALT_RESTR_TEXT

private static final java.lang.String NO_ALT_RESTR_TEXT
See Also:
Constant Field Values

simTime

private SimulationTime simTime
The SimulationTime of this snapshot of the aircraft's state.


acid

private Acid acid

airLine

private java.lang.String airLine

acType

private AcType acType
This aircraft type is the scenario equivalent: for the aircraft type as specified in the flight plan, get the AcType from Flight(State).


ufpAcType

private AcType ufpAcType
This aircraft type is the actual aircraft type from the flight plan. Although this is what is most used for DR&A output, the getAcType() method will return the scenario equivalent because Aircraft does.


altRate

private AltitudeRate altRate

depRwy

private AirportRwyID depRwy

arrRwy

private AirportRwyID arrRwy

freq

private Frequency freq

desiredFreq

private Frequency desiredFreq

pos

private Position pos

filedRouteString

private java.lang.String filedRouteString

currentRouteString

private java.lang.String currentRouteString

currentRouteStrWithBracket

private java.lang.String currentRouteStrWithBracket

dynamicsTypeString

private java.lang.String dynamicsTypeString

groupInfo

private java.lang.String groupInfo

startTime

private SimulationTime startTime

tas

private TrueAirspeed tas

ias

private IndicatedAirspeed ias

spID

private java.lang.Object spID

sector

private Sector sector

geoSector

private GeoSector geoSector

transponder

private Transponder transponder

heading

private TrueHeading heading

turnRate

private TurnRate turnRate

weight

private AircraftWeight weight

weightClass

private WeightClass weightClass

coeffOfLift

private Coefficient coeffOfLift

flapSettingStr

private java.lang.String flapSettingStr
Flap setting (as a String) of the aircraft during this second.


landingGearDeployed

private java.lang.Boolean landingGearDeployed

speedBrakesOn

private java.lang.Boolean speedBrakesOn

isDataEquipped

private java.lang.Boolean isDataEquipped

desiredAltitude

private Altitude desiredAltitude

desiredHeading

private TrueHeading desiredHeading

desiredIAS

private IndicatedAirspeed desiredIAS

desiredRollAngle

private RollAngle desiredRollAngle

drag

private Drag drag

dragCoefficient

private Coefficient dragCoefficient

flightPathAngle

private FlightPathAngle flightPathAngle

mach

private Mach mach

desiredMach

private Mach desiredMach

navEquip

private java.lang.String navEquip

cleared

private java.lang.Boolean cleared

regionName

private java.lang.String regionName

rollAngle

private RollAngle rollAngle

thrust

private Thrust thrust

groundTrackHeading

private GroundTrackHeading groundTrackHeading

groundTrackSpeed

private GroundTrackSpeed groundTrackSpeed

groundTrack

private Distance groundTrack

flyingStatus

private FlyingStatus flyingStatus

desiredMagHeading

private MagneticHeading desiredMagHeading

magneticHeading

private MagneticHeading magneticHeading

modusIas

private IndicatedAirspeed modusIas

modusMach

private Mach modusMach

modusAlt

private Altitude modusAlt

modusAltRate

private AltitudeRate modusAltRate

currManeuverString

private java.lang.String currManeuverString

lateralManeuverString

private java.lang.String lateralManeuverString

engineClass

private java.lang.String engineClass

routeRemainDist

private Distance routeRemainDist

restrRouteNode

private RouteNode restrRouteNode
Route with restrictions that affect the longitudinal maneuvers (decision points are at route nodes): null means route has no route restrictions.


altRestrictionDist

private Distance altRestrictionDist
Distance to next route restriction, or null if no route restrictions. This is used in the DragDeviceController to determine if speed brakes should be used.


methodMap

private static final MethodMap methodMap
Map of delimWritable methods as MethodSpec objects.


flapSetting

private final FlapSetting flapSetting
FlapSetting field retained for backward compatibility: for recordings from TGF versions prior to 2006/06/29. Non-null for recordings until 10/27/08, can remove two years hence, or sooner with a serialization fields overrride.

See Also:
flapSettingStr
Constructor Detail

AircraftState

public AircraftState(SimulationTime simTime)

AircraftState

public AircraftState(double simTime)
Constructor for the aircraft state that specifies the specific second of simulation time that the aircraft data refers to.

Method Detail

getCurrentManeuver

public java.lang.String getCurrentManeuver()

setAcid

public void setAcid(Acid acid)
Sets the aircraft ID (ACID) identifying the aircraft.


setFlyingStatus

public void setFlyingStatus(FlyingStatus flyingStatus)

setAcType

public void setAcType(java.lang.String acType)
Set the type of aircraft: this is the scenario's type equivalent: NOT NECESSARILY the aircraft type from the flight plan.

Parameters:
acType - The aircraft type equivalent used by Aircraft.

setAcType

public void setAcType(AcType acType)
Set the type of aircraft: this is the scenario's type equivalent: NOT NECESSARILY the aircraft type from the flight plan.

Parameters:
acType - The aircraft type equivalent used by Aircraft.

setUfpAcType

public void setUfpAcType(AcType ufpAcType)
Set the actual aircraft type from the flight plan: standard aircraft type output for DR&A. This is the AcType from the Flight(State) object.

Parameters:
ufpAcType - The type of the aircraft specified in the flight plan.

setAirLine

public void setAirLine(java.lang.String airLine)

setAircraftWeight

public void setAircraftWeight(AircraftWeight weight)

setAltRate

public void setAltRate(AltitudeRate altRate)

setGroupInfo

public void setGroupInfo(java.lang.String groupInfo)

setArrRwy

public void setArrRwy(AirportRwyID arrRwy)

setCoeffOfLift

public void setCoeffOfLift(Coefficient coeffOfLift)

setCurrentFlapSetting

public void setCurrentFlapSetting(FlapSetting flapSetting)

setSpeedBrakesOn

public void setSpeedBrakesOn(java.lang.Boolean isOn)

setLandingGearDeployed

public void setLandingGearDeployed(java.lang.Boolean isDeployed)

setDepRwy

public void setDepRwy(AirportRwyID depRwy)

setDesiredAltitude

public void setDesiredAltitude(Altitude desiredAltitude)

setDesiredFrequency

public void setDesiredFrequency(Frequency desiredFrequency)

setDesiredHeading

public void setDesiredHeading(TrueHeading desiredHeading)

setDesiredIndicatedAirspeed

public void setDesiredIndicatedAirspeed(IndicatedAirspeed desiredIAS)

setDesiredMach

public void setDesiredMach(Mach desiredMach)

setDesiredMagneticHeading

public void setDesiredMagneticHeading(MagneticHeading desiredMagHeading)

setDesiredRollAngle

public void setDesiredRollAngle(RollAngle desiredRollAngle)

setDrag

public void setDrag(Drag drag)

setDragCoefficient

public void setDragCoefficient(Coefficient dragCoefficient)

setFiledRouteString

public void setFiledRouteString(java.lang.String filedRouteString)

setRouteWithBracketLogicString

public void setRouteWithBracketLogicString(java.lang.String currentRouteStrWithBracket)

setRouteString

public void setRouteString(java.lang.String currentRouteString)

setRouteRemainDist

public void setRouteRemainDist(Distance routeRemainDist)

setDynamicsType

public void setDynamicsType(java.lang.String currentDynamics)

setFlightPathAngle

public void setFlightPathAngle(FlightPathAngle flightPathAngle)

setFrequency

public void setFrequency(Frequency frequency)

setGroundTrack

public void setGroundTrack(Distance distanceTravelled)
Updates the distance travelled since the aircraft start. DraStore will set this value if DraStore.setCalcDistance(true) was called and it receives this AircraftState.


setGroundTrackHeading

public void setGroundTrackHeading(GroundTrackHeading groundTrackHeading)

setGroundTrackSpeed

public void setGroundTrackSpeed(GroundTrackSpeed groundTrackSpeed)

setIndicatedAirspeed

public void setIndicatedAirspeed(IndicatedAirspeed ias)

setMach

public void setMach(Mach mach)

setMagneticHeading

public void setMagneticHeading(MagneticHeading magneticHeading)

setPosition

public void setPosition(Position pos)

setRollAngle

public void setRollAngle(RollAngle rollAngle)

setSector

public void setSector(Sector sector)

setGeoSector

public void setGeoSector(GeoSector geoSector)

setThrust

public void setThrust(Thrust thrust)

setTrueAirspeed

public void setTrueAirspeed(TrueAirspeed tas)

setTrueHeading

public void setTrueHeading(TrueHeading heading)

setTransponder

public void setTransponder(Transponder transponder)

setTurnRate

public void setTurnRate(TurnRate turnRate)

setWeightClass

public void setWeightClass(WeightClass weightClass)

setStartTime

public void setStartTime(SimulationTime startTime)

getName

public java.lang.String getName()
Returns ACID; if used as a storage key, old AircraftStates will be replaced by new AircraftStates each second.

Specified by:
getName in interface DraStorable
Specified by:
getName in interface SimComparable
Specified by:
getName in interface ManagedObject
Specified by:
getName in class State
Returns:
Returns name unique to the class (or replacement of old object).

clone

public java.lang.Object clone()
Specified by:
clone in interface DraStorable
Overrides:
clone in class java.lang.Object
Returns:
Returns a clone of the aircraft state.

getAcid

public Acid getAcid()
Description copied from interface: HasAcid
Planned change of String ACID to type Acid.

Specified by:
getAcid in interface HasAcid
Returns:
Returns the aircraft ID (as an Acid) of the aircraft.

getFlyingStatus

public FlyingStatus getFlyingStatus()
Returns the flying state of the aircraft.

Specified by:
getFlyingStatus in interface HasFlyingStatus
Returns:
The flying state of the Aircraft.

getAltitude

public Altitude getAltitude()
Returns:
Returns the Altitude of the aircraft.

getLatitude

public Latitude getLatitude()
Returns:
Returns the Latitude of the aircraft.

getLongitude

public Longitude getLongitude()
Returns:
Returns the Longitude of the aircraft.

getAcType

public AcType getAcType()
Returns the type of aircraft: this is the scenario's type equivalent: NOT NECESSARILY the aircraft type from the flight plan or the type generated by the standard DR&A output. To get the aircraft type specified by the flight plan, use getUfpAcType().

Returns:
Returns the scenario's equivalent of the aircraft type.
See Also:
getUfpAcType()

getUfpAcType

public AcType getUfpAcType()
Returns the type of aircraft specified in the FLIGHT PLAN (getAcType() returns the aircraft type equivalent used by the scenario). Although the standard data reduction output is the flight plan AcType, since it is what the customer expects to see, getAcType() returns the scenario type equivalent so that it matches the usage in Aircraft.

Returns:
Returns the type of the aircraft specified in the flight plan.
See Also:
getAcType()

getSector

public Sector getSector()
Specified by:
getSector in interface HasSector
Returns:
Returns the sector.

getGeoSector

public GeoSector getGeoSector()

getAircraftWeight

public AircraftWeight getAircraftWeight()

getTotalWeight

public Weight getTotalWeight()
Return the total weight of the aircraft as a Weight.


getAirLine

public java.lang.String getAirLine()

getAltRate

public AltitudeRate getAltRate()

getGroupInfo

public java.lang.String getGroupInfo()

getArrRwy

public AirportRwyID getArrRwy()
Description copied from interface: HasArrRwy
This will soon be deprecated. The airport ID is a unique three letter identifier. Runway name is a String containing two numbers and a possible L/R/C (left, right, center) indicator character.

Specified by:
getArrRwy in interface HasArrRwy
Returns:
Return format: airportID/runwayName (e.g. FFM/25L)

getBeaconCode

public BeaconCode getBeaconCode()
Specified by:
getBeaconCode in interface HasBeaconCode

getCoeffOfLift

public Coefficient getCoeffOfLift()

getDepRwy

public AirportRwyID getDepRwy()
Description copied from interface: HasDepRwy
This will soon be deprecated. The airport ID is a unique three letter identifier. Runway name is a String containing two numbers and a possible L/R/C (left, right, center) indicator character.

Specified by:
getDepRwy in interface HasDepRwy
Returns:
Return format: airportID/runwayName (e.g. FFM/25L)

getDesiredAltitude

public Altitude getDesiredAltitude()

getDesiredFrequency

public Frequency getDesiredFrequency()

getDesiredHeading

public TrueHeading getDesiredHeading()

getDesiredIndicatedAirspeed

public IndicatedAirspeed getDesiredIndicatedAirspeed()

getDesiredMach

public Mach getDesiredMach()

getDesiredMagneticHeading

public MagneticHeading getDesiredMagneticHeading()

getDesiredRollAngle

public RollAngle getDesiredRollAngle()

getDrag

public Drag getDrag()

getDragCoefficient

public Coefficient getDragCoefficient()

getFiledRouteString

public java.lang.String getFiledRouteString()

getFlapSetting

public java.lang.String getFlapSetting()

isSpeedBrakesOn

public java.lang.Boolean isSpeedBrakesOn()

isLandingGearDeployed

public java.lang.Boolean isLandingGearDeployed()

getFlightPathAngle

public FlightPathAngle getFlightPathAngle()

getFrequency

public Frequency getFrequency()
Specified by:
getFrequency in interface HasFrequency
Returns:
Returns the frequency.

getGroundTrack

public Distance getGroundTrack()

getGroundTrackHeading

public GroundTrackHeading getGroundTrackHeading()

getGroundTrackSpeed

public GroundTrackSpeed getGroundTrackSpeed()

getIndicatedAirspeed

public IndicatedAirspeed getIndicatedAirspeed()

getMach

public Mach getMach()

getMagneticHeading

public MagneticHeading getMagneticHeading()

getNavEquip

public java.lang.String getNavEquip()

getPosition

public Position getPosition()
Specified by:
getPosition in interface HasPosition
Returns:
Returns the position of the object.

getRegionName

public java.lang.String getRegionName()

getRouteString

public java.lang.String getRouteString()

getRouteRemainDist

public Distance getRouteRemainDist()

getRollAngle

public RollAngle getRollAngle()

getCurrentRoute

public java.lang.String getCurrentRoute()
Description copied from interface: HasFlyingStatus
Returns the current route as a String.

Specified by:
getCurrentRoute in interface HasFlyingStatus

getCurrentRouteWithBracketLogic

public java.lang.String getCurrentRouteWithBracketLogic()

getSpdAltManeuverString

public java.lang.String getSpdAltManeuverString()

getLateralManeuverString

public java.lang.String getLateralManeuverString()

getDynamicsType

public java.lang.String getDynamicsType()

getRestrictionString

public java.lang.String getRestrictionString()
Return a String with info on the next altitude restriction: string is empty ("") if there is no altitude restriction on the route.


getSimTime

public SimulationTime getSimTime()
Returns the SimulationTime corresponding to the aircraft state values.

Specified by:
getSimTime in interface HasSimTime
Specified by:
getSimTime in class State
Returns:
Returns the simulation time.

setSimTime

public void setSimTime(SimulationTime aSimTime)

getStartTime

public SimulationTime getStartTime()

getThrust

public Thrust getThrust()

getTrueAirspeed

public TrueAirspeed getTrueAirspeed()

getTrueHeading

public TrueHeading getTrueHeading()
Specified by:
getTrueHeading in interface HasTrueHeading
Returns:
Returns the true heading.

getTransponder

public Transponder getTransponder()

getTurnRate

public TurnRate getTurnRate()

getWeightClass

public WeightClass getWeightClass()
Specified by:
getWeightClass in interface HasWeightClass
Returns:
Returns the aircraft weight class.

getSimCompareCriteria

public SimCompareCriteria getSimCompareCriteria()
Returns the SimCompareCriteria used for AircraftState objects, used to compare AircraftStates across simulations to see if the sims match.

Specified by:
getSimCompareCriteria in interface SimComparable
Returns:
Returns the SimCompareCriteria used for AircraftState.

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException
Set Sector (and Frequency) if not defined and if DraStore is active.

Throws:
java.lang.ClassCastException - Could be caused by recording made prior to 2002-05-03 with old RunwayID type.
java.io.IOException
java.lang.ClassNotFoundException

readObjectConciseVersion

private void readObjectConciseVersion(java.io.ObjectInputStream in)
                               throws java.io.IOException,
                                      java.lang.ClassNotFoundException
Throws:
java.io.IOException
java.lang.ClassNotFoundException

makeMethodMap

private static MethodMap makeMethodMap()
Creates the MethodMap of field names and MethodSpecs.


getMethodMap

public MethodMap getMethodMap()
Returns the AircraftState information in DelimWritable format.

Specified by:
getMethodMap in interface DelimWritable
Returns:
Returns fields as a map of MethodSpec objects.

getTypeList

public static ListSelectable[] getTypeList()
Returns certain slow-to-change fields as a ListSelectable array of MethodSpecSelectable objects.

See Also:
AircraftFieldDurationFactory

getModusMach

public Mach getModusMach()
Return the modus value for the speed in Mach.


getModusAlt

public Altitude getModusAlt()
Return the modus value for the altitude.


getModusAltRate

public AltitudeRate getModusAltRate()
Return the modus value for the altitude rate.


getModusIas

public IndicatedAirspeed getModusIas()
Return the modus value for the indicated airspeed.


setModusResult

public void setModusResult(ModusResult modusResult)
Set the modus values using a ModusResult.


setRegionName

public void setRegionName(java.lang.String regionName)
Sets region name; only needed if setModusResult() is not called.


toDraText

public java.lang.String toDraText()
Returns the AircraftState information as a DR&A text String (contains location in latitude/longitude).

Specified by:
toDraText in interface TextWritable
Returns:
Returns the AircraftState information in TextWritable format.

toDraText

public java.lang.String toDraText(MapProjection projection,
                                  DistanceUnits dUnits)
Returns the AircraftState information as a DR&A text String: if the parameter passed is TRUE, then text contains xy-coordinates to describe the location instead of latitude/longitude.

Specified by:
toDraText in interface HasTextXY
Parameters:
projection - Projection to use if writing location in xy-coords.
dUnits - DistanceUnits to use if writing location in xy-coords.
Returns:
Returns the AircraftState information in TextWritable format.

toString

public java.lang.String toString()
Prints the AircraftState information to a String.

Overrides:
toString in class java.lang.Object
Returns:
Returns the AircraftState information in string format.

getSpID

public SpID getSpID()
Gets the ID of the SimPilotStation that this is assigned to.


setSpID

public void setSpID(SpID spID)
Sets the ID of the SimPilotStation that this is assigned to.

Parameters:
spID - Simpilot workstation to assign this to.

setNavEquip

public void setNavEquip(java.lang.String navEquip)
Parameters:
navEquip -

setIsClearedForTakeOff

public void setIsClearedForTakeOff(java.lang.Boolean cleared)

getIsClearedForTakeOff

public java.lang.Boolean getIsClearedForTakeOff()

setSpdAltManeuver

public void setSpdAltManeuver(java.lang.String spdAltManeuverStr)

setSpdAltManeuver

public void setSpdAltManeuver(SpdAltManeuver spdAltManeuver)

setCurrentManeuver

public void setCurrentManeuver(java.lang.String aName)

setLateralManeuverString

public void setLateralManeuverString(java.lang.String latGuidanceManeuver)

getAltRestrictionDist

public Distance getAltRestrictionDist()

setAltRestrictionDist

public void setAltRestrictionDist(Distance altRestrictionDist)

getRestrRouteNode

public RouteNode getRestrRouteNode()

setRestrRouteNode

public void setRestrRouteNode(RouteNode restrRouteNode)

setEngineClass

public void setEngineClass(java.lang.String engineClass)

getEngineClass

public java.lang.String getEngineClass()

setIsDatalinkEquipped

public void setIsDatalinkEquipped(boolean value)

isDatalinkEquipped

public boolean isDatalinkEquipped()