Package org.deltava.beans.flight

Class ACARSFlightReport

java.lang.Object

org.deltava.beans.DatabaseBean

org.deltava.beans.Flight

org.deltava.beans.flight.FlightReport

org.deltava.beans.flight.FDRFlightReport

org.deltava.beans.flight.ACARSFlightReport

All Implemented Interfaces:

Serializable, Comparable<Object>, AuthoredBean, CalendarEntry, FlightData, FlightNumber, IDBean, FlightTimes, RoutePair, TimeSpan, ViewEntry, Cacheable

Direct Known Subclasses:

SimFDRFlightReport

public class ACARSFlightReport
extends FDRFlightReport
implements FlightTimes

A class for storing ACARS-submitted Flight Reports.

Since:

1.0

Version:

11.1

Author:

Luke

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.deltava.beans.schedule.RoutePair

RoutePair.RoutePairImpl

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GENERIC_SDK

Fields inherited from class org.deltava.beans.flight.FDRFlightReport

_stateChangeTimes

Fields inherited from class org.deltava.beans.flight.FlightReport

ATTR_ACADEMY, ATTR_ACARS, ATTR_AIRSPACEWARN, ATTR_CHARTER, ATTR_CHECKRIDE, ATTR_DISPATCH, ATTR_DIVERT, ATTR_ETOPSWARN, ATTR_FDR_MASK, ATTR_FPI, ATTR_HISTORIC, ATTR_IVAO, ATTR_NOTRATED, ATTR_ONLINE_MASK, ATTR_PEDGE, ATTR_POSCON, ATTR_RANGEWARN, ATTR_REFUELWARN, ATTR_ROUTEWARN, ATTR_RWYSFCWARN, ATTR_RWYWARN, ATTR_SIMBRIEF, ATTR_SIMFDR, ATTR_TIMEWARN, ATTR_VATSIM, ATTR_WARN_MASK, ATTR_WEIGHTWARN, ATTR_XACARS, MIN_ACARS_CLIENT

Constructor Summary

Constructors

Constructor	Description
ACARSFlightReport(Airline a, int flightNumber, int leg)	Creates a new ACARS Flight Report object with a given flight.

Method Summary

Modifier and Type	Method	Description
String	getAircraftCode()	Returns the aircraft code used for this flight.
String	getAircraftPath()	Returns the aircraft path in the simulator.
String	getAuthor()	Returns the aircraft author.
double	getAverageFrameRate()	Returns the average frame rate for this flight.
int	getBeta()	Returns the ACARS beta build number.
Duration	getBlockTime()	Returns the total time of the flight.
Duration	getBoardTime()	Returns the amount of time spent loading passengers/cargo.
long	getCapabilities()	Returns the aircraft/simulator capabilities flags.
int	getCargoWeight()	Returns the total cargo weight.
int	getClientBuild()	Returns the ACARS client build number.
Duration	getDeboardTime()	Returns the amount of time spent unloading passengers/cargo.
String	getFDE()	Returns the FDE used for this flight.
Recorder	getFDR()	Returns the Flight Data recorder used for this flight.
ILSCategory	getLandingCategory()	Returns the ILS category.
double	getLandingG()	Returns the G-Forces at touchdown.
final int	getLength()	Returns the length of the fllight in hours multiplied by ten.
ZonedDateTime	getLocalLandingTime()	Returns the local landing date/time.
ZonedDateTime	getLocalTakeoffTime()	Returns the local takeoff date/time.
Duration	getOnlineTime()	Returns the amount of time spent connected to an Online Network.
OnTime	getOnTime()	Returns whether the flight matched the schedule times.
int	getPaxWeight()	Returns the total passenger weight.
int	getRestoreCount()	Returns the number of ACARS in-flight resotres on this flight.
String	getSDK()	Returns the aircraft SDK used for this flight.
String	getTailCode()	Returns the registration code of the aircraft.
int	getTime(int rate)	Returns the amount of time at a given time acceleration rate.
ZonedDateTime	getTimeA()	Returns the flight arrival date/time in the simulator.
ZonedDateTime	getTimeD()	Returns the flight start date/time in the simulator.
Map<Long,Integer>	getTimes()	Returns a Map of times and acceleration rates.
Instant	getTOCTime()	Returns the date/time that the aircraft reached Top of Climb.
Instant	getTODTime()	Returns the date/time that the aircraft reached Top of Descent.
void	setAircraftCode(String code)	Updates the aircraft code used for this flight.
void	setAircraftPath(String path)	Updates the aircraft path in the simulator.
void	setArrivalTime(Instant dt)	Updates the arrival date/time.
void	setAuthor(String author)	Updates the aircraft author.
void	setAverageFrameRate(double avgRate)	Updates the average simulator frame rate for this flight.
void	setBeta(int beta)	Updates the ACARS beta build number.
void	setBoardTime(int secs)	Updates the amount of time spent loading passengers/cargo.
void	setCapabilities(long cap)	Sets aircraft/sim capabilities flags.
void	setCargoWeight(int wt)	Updates the cargo weight.
void	setClientBuild(int ver)	Updates the ACARS client build number.
void	setDeboardTime(int secs)	Updates the amount of time spent unloading passengers/cargo.
void	setDepartureTime(Instant dt)	Updates the departure date/time.
void	setFDE(String airFile)	Updates the FDE used for this flight.
void	setLandingCategory(ILSCategory ilscat)	Sets the ILS category.
void	setLandingG(double g)	Updates the G-Forces at touchdown.
void	setOnlineTime(int secs)	Updates the amount of time spent connected to an Online Network.
void	setOnTime(OnTime o)	Updates whether the flight was on time.
void	setPaxWeight(int wt)	Updates the passenger weight.
void	setRestoreCount(int cnt)	Updates the number of ACARS in-flight restores during this flight.
void	setSDK(String sdk)	Sets the aircraft SDK used.
void	setTailCode(String tc)	Updates the registration code of the aircraft.
void	setTime(int rate, int secs)	Updates the amount of time at a particular time acceleration rate.
void	setTOCTime(Instant dt)	Updates the Top of Climb date/time.
void	setTODTime(Instant dt)	Updates the Top of Descent date/time.

Methods inherited from class org.deltava.beans.flight.FDRFlightReport

getAirborneTime, getDuration, getEndLocation, getEndTime, getGateFuel, getGateWeight, getLandingDistance, getLandingFuel, getLandingHeading, getLandingLocation, getLandingN1, getLandingScore, getLandingSpeed, getLandingTime, getLandingVSpeed, getLandingWeight, getStartLocation, getStartTime, getTakeoffDistance, getTakeoffFuel, getTakeoffHeading, getTakeoffLocation, getTakeoffN1, getTakeoffSpeed, getTakeoffTime, getTakeoffWeight, getTaxiFuel, getTaxiInTime, getTaxiOutTime, getTaxiTime, getTaxiWeight, getTotalFuel, setEndLocation, setEndTime, setGateFuel, setGateWeight, setLandingDistance, setLandingFuel, setLandingHeading, setLandingLocation, setLandingN1, setLandingScore, setLandingSpeed, setLandingTime, setLandingVSpeed, setLandingWeight, setStartLocation, setStartTime, setTakeoffDistance, setTakeoffFuel, setTakeoffHeading, setTakeoffLocation, setTakeoffN1, setTakeoffSpeed, setTakeoffTime, setTakeoffWeight, setTaxiFuel, setTaxiTime, setTaxiWeight, setTotalFuel

Methods inherited from class org.deltava.beans.flight.FlightReport

addStatusUpdate, addStatusUpdate, compareTo, getAttributes, getAuthorID, getCaptEQType, getComments, getDatabaseID, getDate, getDisposedOn, getLoadFactor, getNetwork, getPassengers, getRank, getRemarks, getRoute, getRowClassName, getSimulator, getStatus, getStatusUpdates, getSubmittedOn, hasAttribute, hasDatabaseID, setAttribute, setAttributes, setAuthorID, setCaptEQType, setCaptEQType, setComments, setDatabaseID, setDate, setDisposedOn, setID, setLeg, setLength, setLoadFactor, setNetwork, setPassengers, setRank, setRemarks, setRoute, setSimulator, setStatus, setSubmittedOn

Methods inherited from class org.deltava.beans.Flight

equals, getAirline, getAirportA, getAirportD, getDistance, getEquipmentType, getFlightCode, getFlightNumber, getLeg, getLegCode, getShortCode, hashCode, setAirline, setAirportA, setAirportD, setEquipmentType, setFlightNumber, toString

Methods inherited from class org.deltava.beans.DatabaseBean

cacheKey, getHexID, getID, validateID, validateID

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.deltava.beans.CalendarEntry

getDate

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.deltava.beans.flight.FlightData

getEquipmentType

Methods inherited from interface org.deltava.beans.FlightNumber

getAirline, getFlightNumber, getLeg

Methods inherited from interface org.deltava.beans.schedule.FlightTimes

hasTimes

Methods inherited from interface org.deltava.beans.schedule.RoutePair

createKey, getAirportA, getAirportD, getAirports, getDistance, getFlightType, includes, isPopulated, matches

Field Details

GENERIC_SDK

public static final String GENERIC_SDK

See Also:

• Constant Field Values

Constructor Details

ACARSFlightReport

public ACARSFlightReport(Airline a,
 int flightNumber,
 int leg)

Creates a new ACARS Flight Report object with a given flight.

Parameters:

a - the Airline

flightNumber - the Flight Number

leg - the Leg Number

Throws:

NullPointerException - if the Airline Code is null

IllegalArgumentException - if the Flight Report is zero or negative

IllegalArgumentException - if the Leg is less than 1 or greater than 8

See Also:

• Flight.setAirline(Airline)
• Flight.setFlightNumber(int)
• Flight.setLeg(int)

Method Details

getFDR

public Recorder getFDR()

Description copied from interface: FlightData

Returns the Flight Data recorder used for this flight.

Specified by:

getFDR in interface FlightData

Overrides:

getFDR in class FlightReport

Returns:

a Recorder enum or null if none/unknown

getBlockTime

public Duration getBlockTime()

Description copied from class: FDRFlightReport

Returns the total time of the flight.

Overrides:

getBlockTime in class FDRFlightReport

Returns:

the total Duration

See Also:

• FDRFlightReport.setStartTime(Instant)
• FDRFlightReport.setEndTime(Instant)

getLandingG

public double getLandingG()

Returns the G-Forces at touchdown.

Returns:

the G-Forces in G

See Also:

• setLandingG(double)

getTime

public int getTime(int rate)

Returns the amount of time at a given time acceleration rate.

Parameters:

rate - the acceleration rate

Returns:

the amount of time in seconds at that acceleration rate

See Also:

• setTime(int, int)
• getTimes()

getTimes

public Map<Long,Integer> getTimes()

Returns a Map of times and acceleration rates.

Returns:

a sorted Map of times, keyed by acceleration rate

See Also:

• getTime(int)

getBoardTime

public Duration getBoardTime()

Returns the amount of time spent loading passengers/cargo.

Returns:

the amount of time in seconds

See Also:

• setBoardTime(int)
• getDeboardTime()

getDeboardTime

public Duration getDeboardTime()

Returns the amount of time spent unloading passengers/cargo.

Returns:

the amount of time in seconds

See Also:

• setDeboardTime(int)
• getBoardTime()

getOnlineTime

public Duration getOnlineTime()

Returns the amount of time spent connected to an Online Network.

Returns:

the amount of time in seconds

See Also:

• setOnlineTime(int)

getTOCTime

public Instant getTOCTime()

Returns the date/time that the aircraft reached Top of Climb.

Returns:

the date/time of top of climb

See Also:

• setTOCTime(Instant)

getTODTime

public Instant getTODTime()

Returns the date/time that the aircraft reached Top of Descent.

Returns:

the date/time of top of descent

See Also:

• setTODTime(Instant)

getLength

public final int getLength()

Returns the length of the fllight in hours multiplied by ten. This is done to avoid rounding errors when using a floating point number. ACARS Flight Reports will use the time at 1x, 2x, and 4x acceleration to calculate the flight length if the length field is not already populated. This assumes that the ACARS client has performed the proper multiplication before submitting the data.

Overrides:

getLength in class FlightReport

Returns:

the length of the flight in hours multiplied by ten

See Also:

• FlightReport.getLength()
• getTime(int)

getFDE

public String getFDE()

Returns the FDE used for this flight.

Returns:

the AIR file name, or null

See Also:

• setFDE(String)

getSDK

public String getSDK()

Returns the aircraft SDK used for this flight.

Returns:

the SDK code, or null

See Also:

• setSDK(String)

getAircraftCode

public String getAircraftCode()

Returns the aircraft code used for this flight.

Returns:

the aircraft code

See Also:

• setAircraftCode(String)

getAuthor

public String getAuthor()

Returns the aircraft author.

Returns:

the author name

See Also:

• setAuthor(String)

getAircraftPath

public String getAircraftPath()

Returns the aircraft path in the simulator.

Returns:

the path name

See Also:

• setAircraftPath(String)

getAverageFrameRate

public double getAverageFrameRate()

Description copied from class: FDRFlightReport

Returns the average frame rate for this flight.

Specified by:

getAverageFrameRate in class FDRFlightReport

Returns:

the average frame rate in frames per second

getRestoreCount

public int getRestoreCount()

Returns the number of ACARS in-flight resotres on this flight.

Returns:

the number of flight restores

See Also:

• setRestoreCount(int)

getClientBuild

public int getClientBuild()

Returns the ACARS client build number.

Returns:

the client build number

See Also:

• ACARSLogEntry.setClientBuild(int)

getBeta

public int getBeta()

Returns the ACARS beta build number.

Returns:

the beta number

See Also:

• ACARSLogEntry.setBeta(int)

getLandingCategory

public ILSCategory getLandingCategory()

Returns the ILS category.

Returns:

the ILS Category

getPaxWeight

public int getPaxWeight()

Returns the total passenger weight.

Returns:

the weight in pounds

getCargoWeight

public int getCargoWeight()

Returns the total cargo weight.

Returns:

the weight in pounds

getCapabilities

public long getCapabilities()

Description copied from class: FDRFlightReport

Returns the aircraft/simulator capabilities flags.

Specified by:

getCapabilities in class FDRFlightReport

Returns:

the Capabilities flag bitmap

getTimeD

public ZonedDateTime getTimeD()

Returns the flight start date/time in the simulator.

Specified by:

getTimeD in interface FlightTimes

Returns:

the departure date/time

See Also:

• FlightTimes.getTimeA()

getLocalTakeoffTime

public ZonedDateTime getLocalTakeoffTime()

Returns the local takeoff date/time. This is the simulator's local time at takeoff.

Returns:

the takeoff date/time

getLocalLandingTime

public ZonedDateTime getLocalLandingTime()

Returns the local landing date/time. This is the simulator's local time at touchdown.

Returns:

the touchdown date/time

getTimeA

public ZonedDateTime getTimeA()

Returns the flight arrival date/time in the simulator.

Specified by:

getTimeA in interface FlightTimes

Returns:

the arrival date/time

See Also:

• FlightTimes.getTimeD()

getOnTime

public OnTime getOnTime()

Returns whether the flight matched the schedule times.

Returns:

an OnTime enumeration

getTailCode

public String getTailCode()

Returns the registration code of the aircraft.

Returns:

the tail code

setTailCode

public void setTailCode(String tc)

Updates the registration code of the aircraft.

Parameters:

tc - the tail code

setLandingG

public void setLandingG(double g)

Updates the G-Forces at touchdown.

Parameters:

g - the G-forces in G

See Also:

• getLandingG()

setTime

public void setTime(int rate,
 int secs)

Updates the amount of time at a particular time acceleration rate.

Parameters:

rate - the acceleration rate

secs - the amount of time in seconds

Throws:

IllegalArgumentException - if rate is not 0, 1, 2, 4

See Also:

• getTime(int)

setBoardTime

public void setBoardTime(int secs)

Updates the amount of time spent loading passengers/cargo.

Parameters:

secs - the time in seconds

See Also:

• getBoardTime()
• setDeboardTime(int)

setDeboardTime

public void setDeboardTime(int secs)

Updates the amount of time spent unloading passengers/cargo.

Parameters:

secs - the time in seconds

See Also:

• getDeboardTime()
• setBoardTime(int)

setOnlineTime

public void setOnlineTime(int secs)

Updates the amount of time spent connected to an Online Network.

Parameters:

secs - the time in seconds

See Also:

• getOnlineTime()

setTOCTime

public void setTOCTime(Instant dt)

Updates the Top of Climb date/time.

Parameters:

dt - the date/time at top of climb

See Also:

• getTOCTime()

setTODTime

public void setTODTime(Instant dt)

Updates the Top of Descent date/time.

Parameters:

dt - the date/time at top of descent

See Also:

• getTODTime()

setFDE

public void setFDE(String airFile)

Updates the FDE used for this flight.

Parameters:

airFile - the AIR file name, or null if unknown

See Also:

• getFDE()

setAircraftCode

public void setAircraftCode(String code)

Updates the aircraft code used for this flight.

Parameters:

code - the aircraft code

See Also:

• getAircraftCode()

setAverageFrameRate

public void setAverageFrameRate(double avgRate)

Updates the average simulator frame rate for this flight.

Parameters:

avgRate - the average rate in frames per second

See Also:

• FDRFlightReport.getAverageFrameRate()

setRestoreCount

public void setRestoreCount(int cnt)

Updates the number of ACARS in-flight restores during this flight.

Parameters:

cnt - the number of flight restores

See Also:

• getRestoreCount()

setClientBuild

public void setClientBuild(int ver)

Updates the ACARS client build number.

Parameters:

ver - the build number

See Also:

• ACARSLogEntry.getClientBuild()

setBeta

public void setBeta(int beta)

Updates the ACARS beta build number.

Parameters:

beta - the beta number

See Also:

• ACARSLogEntry.getBeta()

setLandingCategory

public void setLandingCategory(ILSCategory ilscat)

Sets the ILS category.

Parameters:

ilscat - the ILS category

setSDK

public void setSDK(String sdk)

Sets the aircraft SDK used.

Parameters:

sdk - the SDK code

setAuthor

public void setAuthor(String author)

Updates the aircraft author.

Parameters:

author - the author name

See Also:

• getAuthor()

setAircraftPath

public void setAircraftPath(String path)

Updates the aircraft path in the simulator.

Parameters:

path - the path name

See Also:

• getAircraftPath()

setCapabilities

public void setCapabilities(long cap)

Sets aircraft/sim capabilities flags.

Parameters:

cap - the Capabilities flags

setPaxWeight

public void setPaxWeight(int wt)

Updates the passenger weight.

Parameters:

wt - the total passenger weight, in pounds

setCargoWeight

public void setCargoWeight(int wt)

Updates the cargo weight.

Parameters:

wt - the total cargo weight, in pounds

setDepartureTime

public void setDepartureTime(Instant dt)

Updates the departure date/time. This is the simulator's local time at start time.

Parameters:

dt - the departure date/time

See Also:

• FDRFlightReport.getStartTime()

setArrivalTime

public void setArrivalTime(Instant dt)

Updates the arrival date/time. This is the simulators' local time at end time.

Parameters:

dt - the arrival date/time

See Also:

• FDRFlightReport.getEndTime()

setOnTime

public void setOnTime(OnTime o)

Updates whether the flight was on time.

Parameters:

o - an OnTime value