agi.foundation.aircraftpropagation

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

Class HorizontalBehaviorDerivatives

java.lang.Object

agi.foundation.aircraftpropagation.HorizontalBehaviorDerivatives

All Implemented Interfaces:

IEquatable<HorizontalBehaviorDerivatives>, ImmutableValueType, ValueType

public final class HorizontalBehaviorDerivatives
extends Object
implements IEquatable<HorizontalBehaviorDerivatives>, ImmutableValueType

The derivatives which define the horizontal behavior of a maneuver.

Constructor Summary

Constructors

Constructor and Description
HorizontalBehaviorDerivatives() Initializes a new instance.
HorizontalBehaviorDerivatives(ManeuverReferenceAxes maneuverReferenceAxes, double angularRate) Initializes the horizontal derivatives with respect to the indicated maneuver axes.

Method Summary

Modifier and Type	Method and Description
static boolean	equals(HorizontalBehaviorDerivatives left, HorizontalBehaviorDerivatives right) Returns true if the two instances are exactly equal.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(HorizontalBehaviorDerivatives other) Indicates whether another instance of this type is exactly equal to this instance.
double	getAngularRate() Gets the rate of change of the angular reference in the horizontal plane.
ManeuverReferenceAxes	getManeuverReferenceAxes() Gets the axes in which the horizontal behavior of a maneuver is defined.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static boolean	notEquals(HorizontalBehaviorDerivatives left, HorizontalBehaviorDerivatives right) Returns true if the two instances are not exactly equal.

Methods inherited from class java.lang.Object

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

Constructor Detail

HorizontalBehaviorDerivatives

public HorizontalBehaviorDerivatives()

Initializes a new instance.

HorizontalBehaviorDerivatives

public HorizontalBehaviorDerivatives(@Nonnull
                                     ManeuverReferenceAxes maneuverReferenceAxes,
                                     double angularRate)

Initializes the horizontal derivatives with respect to the indicated maneuver axes.

Parameters:

maneuverReferenceAxes - The axes in which the horizontal behavior of a maneuver is defined

angularRate - The rate of change of the angular reference in the horizontal plane.

Method Detail

getManeuverReferenceAxes

@Nonnull
public final ManeuverReferenceAxes getManeuverReferenceAxes()

Gets the axes in which the horizontal behavior of a maneuver is defined.

getAngularRate

public final double getAngularRate()

Gets the rate of change of the angular reference in the horizontal plane.

The angular reference is the true course if the ManeuverReferenceAxes (get) is ManeuverReferenceAxes.STATIC_ATMOSPHERE. The angular reference is the true heading if the ManeuverReferenceAxes (get) is ManeuverReferenceAxes.MOVING_ATMOSPHERE.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

equalsType

public final boolean equalsType(@Nonnull
                                HorizontalBehaviorDerivatives other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<HorizontalBehaviorDerivatives>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

equals

public static boolean equals(@Nonnull
                             HorizontalBehaviorDerivatives left,
                             @Nonnull
                             HorizontalBehaviorDerivatives right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static boolean notEquals(@Nonnull
                                HorizontalBehaviorDerivatives left,
                                @Nonnull
                                HorizontalBehaviorDerivatives right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.