agi.foundation.aircraftpropagation

(agi.foundation.aircraftpropagation-2025r1.jar)

Class AircraftReferenceState

java.lang.Object

agi.foundation.aircraftpropagation.AircraftReferenceState

public class AircraftReferenceState
extends Object

Defines an initial state of an aircraft in terms of its position and velocity.

Constructor Summary

Constructors

Constructor and Description
AircraftReferenceState(JulianDate epoch) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
JulianDate	getEpoch() Gets the epoch at which the reference state of the aircraft is defined.
TerrainProvider	getHeightReferenceSurface() Gets the reference surface used in defining the height coordinate of the Position (get / set).
Cartographic	getPosition() Gets the position of the aircraft.
AzimuthHorizontalVertical	getVelocity() Gets the velocity of the aircraft with respect to the static or moving local atmosphere, depending on the value of VelocityReferenceAxes (get / set).
ManeuverReferenceAxes	getVelocityReferenceAxes() Gets the reference axes used to define the velocity of the aircraft with respect to either the static or moving local atmosphere.
void	setEpoch(JulianDate value) Sets the epoch at which the reference state of the aircraft is defined.
void	setHeightReferenceSurface(TerrainProvider value) Sets the reference surface used in defining the height coordinate of the Position (get / set).
void	setPosition(Cartographic value) Sets the position of the aircraft.
void	setVelocity(AzimuthHorizontalVertical value) Sets the velocity of the aircraft with respect to the static or moving local atmosphere, depending on the value of VelocityReferenceAxes (get / set).
void	setVelocityReferenceAxes(ManeuverReferenceAxes value) Sets the reference axes used to define the velocity of the aircraft with respect to either the static or moving local atmosphere.
Motion1<Cartesian>	toMotionInFixedFrame(WindModel winds) Converts the reference state of the aircraft into motion with respect to the fixed frame of the HeightReferenceSurface (get / set).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AircraftReferenceState

public AircraftReferenceState(@Nonnull
                              JulianDate epoch)

Initializes a new instance. VelocityReferenceAxes (get / set) will be set to ManeuverReferenceAxes.STATIC_ATMOSPHERE and HeightReferenceSurface (get / set) will be set to the MeanSeaLevel (get / set) property of the EarthCentralBody, which must be configured before using this type.

Parameters:

epoch - The epoch at which the reference state of the aircraft is defined.

Method Detail

getEpoch

@Nonnull
public final JulianDate getEpoch()

Gets the epoch at which the reference state of the aircraft is defined.

setEpoch

public final void setEpoch(@Nonnull
                           JulianDate value)

Sets the epoch at which the reference state of the aircraft is defined.

getHeightReferenceSurface

public final TerrainProvider getHeightReferenceSurface()

Gets the reference surface used in defining the height coordinate of the Position (get / set).

setHeightReferenceSurface

public final void setHeightReferenceSurface(TerrainProvider value)

Sets the reference surface used in defining the height coordinate of the Position (get / set).

getPosition

@Nonnull
public final Cartographic getPosition()

Gets the position of the aircraft. The height coordinate is the height with respect to the HeightReferenceSurface (get / set).

setPosition

public final void setPosition(@Nonnull
                              Cartographic value)

Sets the position of the aircraft. The height coordinate is the height with respect to the HeightReferenceSurface (get / set).

getVelocityReferenceAxes

@Nonnull
public final ManeuverReferenceAxes getVelocityReferenceAxes()

Gets the reference axes used to define the velocity of the aircraft with respect to either the static or moving local atmosphere.

setVelocityReferenceAxes

public final void setVelocityReferenceAxes(@Nonnull
                                           ManeuverReferenceAxes value)

Sets the reference axes used to define the velocity of the aircraft with respect to either the static or moving local atmosphere.

getVelocity

@Nonnull
public final AzimuthHorizontalVertical getVelocity()

Gets the velocity of the aircraft with respect to the static or moving local atmosphere, depending on the value of VelocityReferenceAxes (get / set).

setVelocity

public final void setVelocity(@Nonnull
                              AzimuthHorizontalVertical value)

Sets the velocity of the aircraft with respect to the static or moving local atmosphere, depending on the value of VelocityReferenceAxes (get / set).

toMotionInFixedFrame

@Nonnull
public final Motion1<Cartesian> toMotionInFixedFrame(WindModel winds)

Converts the reference state of the aircraft into motion with respect to the fixed frame of the HeightReferenceSurface (get / set).

Parameters:

winds - The wind model for the local atmosphere.

Returns:

The Motion1 in the fixed frame of the central body.

Throws:

PropertyInvalidException - Thrown when the HeightReferenceSurface (get / set) is null.

UnsupportedCaseException - Thrown if the VelocityReferenceAxes (get / set) is not a ManeuverReferenceAxes.