Package com.luciad.ais.model.procedure
Class TLcdAircraftState
java.lang.Object
com.luciad.ais.model.procedure.TLcdAircraftState
Represents the current state of the aircraft flying a procedure. The state
consists of position, course and altitude. The position can be flagged as
invalid when the geometry calculator finds itself in a situation it can't
handle properly. The state also includes the aircraft's performance
characteristics, such as the climb rate and the turn radius.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the current aircraft performance settings.double
Returns the current altitude of the aircraft.double
Returns the current course of the aircraft.Returns the current position of the aircraft.void
Invalidates the current state.boolean
Indicates whether or not the current state is valid.void
setAircraftPerformanceSettings
(TLcdAircraftPerformanceSettings aPerformanceSettings) Sets the current aircraft performance settings.void
setCurrentAltitude
(double aAltitude) Sets the current altitude to the specified value.void
setCurrentCourse
(double aCourse) Sets the current course to the specified value.void
setCurrentPosition
(ILcdPoint aPos) Moves the current position to the specified location.
-
Constructor Details
-
TLcdAircraftState
public TLcdAircraftState()Default constructor. Marks the current state as invalid and sets default values for the aircraft performance settings.
-
-
Method Details
-
getCurrentPosition
Returns the current position of the aircraft. Do not use the returned coordinates if the state is not valid!- Returns:
- the current position of the aircraft
-
getCurrentCourse
public double getCurrentCourse()Returns the current course of the aircraft. The return value may be NaN if the course is currently invalid.- Returns:
- the current course of the aircraft
-
getCurrentAltitude
public double getCurrentAltitude()Returns the current altitude of the aircraft. The return value may be NaN if the altitude is currently invalid.- Returns:
- the current altitude of the aircraft
-
invalidate
public void invalidate()Invalidates the current state. This will result in the position being moved to the origin, and the course and altitude being set to NaN. -
isStateValid
public boolean isStateValid()Indicates whether or not the current state is valid. Position, course and altitude should not be used if this returns false.- Returns:
- a boolean indicating whether or not the current state is valid
-
setCurrentPosition
Moves the current position to the specified location.- Parameters:
aPos
- the new aircraft position
-
setCurrentCourse
public void setCurrentCourse(double aCourse) Sets the current course to the specified value. Set to NaN to indicate that the current course is unknown.- Parameters:
aCourse
- the new course
-
setCurrentAltitude
public void setCurrentAltitude(double aAltitude) Sets the current altitude to the specified value. Set to NaN to indicate that the current altitude is unknown.- Parameters:
aAltitude
- the new altitude
-
getAircraftPerformanceSettings
Returns the current aircraft performance settings.- Returns:
- an
TLcdAircraftPerformanceSettings
-
setAircraftPerformanceSettings
Sets the current aircraft performance settings.- Parameters:
aPerformanceSettings
- anTLcdAircraftPerformanceSettings
-