agi.foundation.aircraftpropagation

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

Class Maneuver

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.aircraftpropagation.Maneuver

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

CompositeManeuver

public abstract class Maneuver
extends DefinitionalObject

An abstract base class which defines an aircraft maneuver.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Maneuver() Initializes a new instance.
protected	Maneuver(Maneuver existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(Maneuver other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
static double	convertHorizontalAirspeedRateToHorizontalGroundSpeedRate(double horizontalGroundSpeed, double sineTrueCourse, double cosineTrueCourse, double sineTrueHeading, double cosineTrueHeading, Cartesian windRate, double horizontalAirspeedRate, double trueCourseRate) Converts the rate of change of horizontal airspeed to rate of change of horizontal ground speed.
static AzimuthHorizontalVertical	convertMovingAtmosphereRatesToStaticAtmosphereRates(double verticalGroundSpeed, double horizontalGroundSpeed, double sineTrueCourse, double cosineTrueCourse, double verticalAirspeed, double horizontalAirspeed, double sineTrueHeading, double cosineTrueHeading, Cartesian windRate, AzimuthHorizontalVertical derivatives) Converts the rates with respect to the moving atmosphere to rates with respect to the static atmosphere.
static double	convertTrueHeadingRateToTrueCourseRate(double horizontalGroundSpeed, double sineTrueCourse, double cosineTrueCourse, double horizontalAirspeed, double sineTrueHeading, double cosineTrueHeading, Cartesian windRate, double horizontalGroundSpeedRate, double trueHeadingRate) Converts the rate of change of true heading to the rate of change of true course.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
abstract Evaluator<Cartesian>	getAccelerationEvaluator(EvaluatorGroup group, IServiceProvider serviceProvider) Gets an instance of an evaluator that can compute the acceleration components of the maneuver.
Evaluator<Cartesian>	getAccelerationEvaluator(IServiceProvider serviceProvider) Gets an instance of an evaluator that can compute the acceleration components of the maneuver.
PerformanceModels	getPerformanceModels() Gets the performance models to be applied to the maneuver.
WindModel	getWindModel() Gets the wind model to be used when evaluating the maneuver.
void	setPerformanceModels(PerformanceModels value) Sets the performance models to be applied to the maneuver.
void	setWindModel(WindModel value) Sets the wind model to be used when evaluating the maneuver.
protected void	validateProperties(EvaluatorGroup group, IServiceProvider serviceProvider) Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

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

Constructor Detail

Maneuver

protected Maneuver()

Initializes a new instance.

Maneuver

protected Maneuver(@Nonnull
                   Maneuver existingInstance,
                   @Nonnull
                   CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObject other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class DefinitionalObject

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected abstract boolean checkForSameDefinition(Maneuver other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the Maneuver.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class DefinitionalObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getWindModel

public final WindModel getWindModel()

Gets the wind model to be used when evaluating the maneuver.

setWindModel

public final void setWindModel(WindModel value)

Sets the wind model to be used when evaluating the maneuver.

getPerformanceModels

public final PerformanceModels getPerformanceModels()

Gets the performance models to be applied to the maneuver.

setPerformanceModels

public final void setPerformanceModels(PerformanceModels value)

Sets the performance models to be applied to the maneuver.

getAccelerationEvaluator

@Nonnull
public final Evaluator<Cartesian> getAccelerationEvaluator(@Nonnull
                                                                     IServiceProvider serviceProvider)

Gets an instance of an evaluator that can compute the acceleration components of the maneuver.

Parameters:

serviceProvider - A service provider which must provide the ILocationPointService service.

Returns:

An evaluator that computes the acceleration components with respect to the local East-North-Up axes.

Throws:

ArgumentNullException - Thrown when serviceProvider is null.

getAccelerationEvaluator

@Nonnull
public abstract Evaluator<Cartesian> getAccelerationEvaluator(@Nonnull
                                                                        EvaluatorGroup group,
                                                                        @Nonnull
                                                                        IServiceProvider serviceProvider)

Gets an instance of an evaluator that can compute the acceleration components of the maneuver.

Parameters:

group - The group in which to create the evaluator and its dependents.

serviceProvider - A service provider which must provide the ILocationPointService service.

Returns:

An evaluator that computes the acceleration components with respect to the local East-North-Up axes.

Throws:

ArgumentNullException - Thrown when group or serviceProvider is null.

validateProperties

protected void validateProperties(@Nonnull
                                  EvaluatorGroup group,
                                  @Nonnull
                                  IServiceProvider serviceProvider)

Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance. Derived classes should call this method when implementing Maneuver.getAccelerationEvaluator(EvaluatorGroup,IServiceProvider), as well as validate their own properties.

Parameters:

group - The group in which to create the evaluator and its dependents.

serviceProvider - A service provider which must provide the ILocationPointService service.

Throws:

ArgumentNullException - Thrown when group or serviceProvider is null.

PropertyInvalidException - Thrown when the property WindModel (get / set) or PerformanceModels (get / set) is null.

convertMovingAtmosphereRatesToStaticAtmosphereRates

@Nonnull
public static AzimuthHorizontalVertical convertMovingAtmosphereRatesToStaticAtmosphereRates(double verticalGroundSpeed,
                                                                                                      double horizontalGroundSpeed,
                                                                                                      double sineTrueCourse,
                                                                                                      double cosineTrueCourse,
                                                                                                      double verticalAirspeed,
                                                                                                      double horizontalAirspeed,
                                                                                                      double sineTrueHeading,
                                                                                                      double cosineTrueHeading,
                                                                                                      @Nonnull
                                                                                                      Cartesian windRate,
                                                                                                      @Nonnull
                                                                                                      AzimuthHorizontalVertical derivatives)

Converts the rates with respect to the moving atmosphere to rates with respect to the static atmosphere.

Parameters:

verticalGroundSpeed - The vertical component of the ground speed.

horizontalGroundSpeed - The horizontal component of the ground speed.

sineTrueCourse - The sine of the true course.

cosineTrueCourse - The cosine of the true course.

verticalAirspeed - The vertical component of the airspeed.

horizontalAirspeed - The horizontal component of the airspeed.

sineTrueHeading - The sine of the true heading.

cosineTrueHeading - The cosine of the true heading.

windRate - The rate of change of the wind in East-North-Up components.

derivatives - The rates of change with respect to the moving atmosphere.

Returns:

The rates with respect to the static atmosphere.

convertTrueHeadingRateToTrueCourseRate

public static double convertTrueHeadingRateToTrueCourseRate(double horizontalGroundSpeed,
                                                            double sineTrueCourse,
                                                            double cosineTrueCourse,
                                                            double horizontalAirspeed,
                                                            double sineTrueHeading,
                                                            double cosineTrueHeading,
                                                            @Nonnull
                                                            Cartesian windRate,
                                                            double horizontalGroundSpeedRate,
                                                            double trueHeadingRate)

Converts the rate of change of true heading to the rate of change of true course.

Parameters:

horizontalGroundSpeed - The horizontal ground speed.

sineTrueCourse - The sine of the true course.

cosineTrueCourse - The cosine of the true course.

horizontalAirspeed - The horizontal airspeed.

sineTrueHeading - The sine of the true heading.

cosineTrueHeading - The cosine of the true heading.

windRate - The rate of change of the wind in East-North-Up components.

horizontalGroundSpeedRate - The rate of change of the horizontal component of ground speed.

trueHeadingRate - The rate of change of the true heading.

Returns:

The rate of change of the true course.

convertHorizontalAirspeedRateToHorizontalGroundSpeedRate

public static double convertHorizontalAirspeedRateToHorizontalGroundSpeedRate(double horizontalGroundSpeed,
                                                                              double sineTrueCourse,
                                                                              double cosineTrueCourse,
                                                                              double sineTrueHeading,
                                                                              double cosineTrueHeading,
                                                                              @Nonnull
                                                                              Cartesian windRate,
                                                                              double horizontalAirspeedRate,
                                                                              double trueCourseRate)

Converts the rate of change of horizontal airspeed to rate of change of horizontal ground speed.

Parameters:

horizontalGroundSpeed - The horizontal ground speed.

sineTrueCourse - The sine of the true course.

cosineTrueCourse - The cosine of the true course.

sineTrueHeading - The sine of the true heading.

cosineTrueHeading - The cosine of the true heading.

windRate - The rate of change of the wind in East-North-Up components.

horizontalAirspeedRate - The rate of change of horizontal airspeed.

trueCourseRate - The rate of change of the true course.

Returns:

The rate of change of horizontal ground speed.