agi.foundation.aircraftpropagation

(agi.foundation.aircraftpropagation-2024r3.jar)

Class AircraftMotionElement

java.lang.Object

agi.foundation.aircraftpropagation.AircraftMotionElement

public class AircraftMotionElement
extends Object

A factory for creating PropagationStateElements representing the position (and velocity) of an aircraft which share the same IntegrationPoint (get) but whose second derivatives are provided by different Maneuvers.

Constructor Summary

Constructors

Constructor and Description
AircraftMotionElement(String id, AircraftReferenceState initialState, WindModel winds) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
PropagationPointElement	applyManeuver(Maneuver maneuver) Produces a point PropagationStateElement that uses the provided maneuver definition to compute the derivatives for integration.
String	getIdentification() Gets the string identifying this instance in the overall output.
Cartesian	getInitialPosition() Gets the initial position in the fixed frame.
Cartesian	getInitialVelocity() Gets the initial velocity in the fixed frame.
Point	getIntegrationPoint() Gets a Point which is parameterized on the position and velocity in the state during integration.
Scalar	getMass() Gets the mass used to determine the equations of motion.
void	setIdentification(String value) Sets the string identifying this instance in the overall output.
void	setInitialPosition(Cartesian value) Sets the initial position in the fixed frame.
void	setInitialVelocity(Cartesian value) Sets the initial velocity in the fixed frame.
void	setMass(Scalar value) Sets the mass used to determine the equations of motion.

Methods inherited from class java.lang.Object

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

Constructor Detail

AircraftMotionElement

public AircraftMotionElement(String id,
                             @Nonnull
                             AircraftReferenceState initialState,
                             @Nonnull
                             WindModel winds)

Initializes a new instance.

Parameters:

id - A unique string identifying this position in the integration output.

initialState - The state at the starting epoch of propagation.

winds - The wind model to be applied when converting the state to the fixed frame.

Method Detail

getIdentification

public final String getIdentification()

Gets the string identifying this instance in the overall output.

setIdentification

public final void setIdentification(String value)

Sets the string identifying this instance in the overall output.

getInitialPosition

@Nonnull
public final Cartesian getInitialPosition()

Gets the initial position in the fixed frame.

setInitialPosition

public final void setInitialPosition(@Nonnull
                                     Cartesian value)

Sets the initial position in the fixed frame.

getInitialVelocity

@Nonnull
public final Cartesian getInitialVelocity()

Gets the initial velocity in the fixed frame.

setInitialVelocity

public final void setInitialVelocity(@Nonnull
                                     Cartesian value)

Sets the initial velocity in the fixed frame.

getIntegrationPoint

public final Point getIntegrationPoint()

Gets a Point which is parameterized on the position and velocity in the state during integration. This point is only valid while the NumericalPropagator is running. For more general use, a PointInterpolator should be created from the NumericalPropagationStateHistory produced by the propagator.

getMass

public final Scalar getMass()

Gets the mass used to determine the equations of motion. Note that the derivatives of mass are not implicitly included in the integration. Another PropagationStateElement must be added to the set of integration elements to account for the change in mass over time.

setMass

public final void setMass(Scalar value)

Sets the mass used to determine the equations of motion. Note that the derivatives of mass are not implicitly included in the integration. Another PropagationStateElement must be added to the set of integration elements to account for the change in mass over time.

applyManeuver

@Nonnull
public final PropagationPointElement applyManeuver(@Nonnull
                                                             Maneuver maneuver)

Produces a point PropagationStateElement that uses the provided maneuver definition to compute the derivatives for integration.

Parameters:

maneuver - The maneuver definition which will define the derivatives for integration.

Returns:

The point propagation state element.