agi.foundation.aircraftpropagation

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

Class VerticalBehaviorDerivatives

java.lang.Object

agi.foundation.aircraftpropagation.VerticalBehaviorDerivatives

All Implemented Interfaces:

IEquatable<VerticalBehaviorDerivatives>, ImmutableValueType, ValueType

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

The derivatives which define the vertical behavior of a maneuver.

Constructor Summary

Constructors

Constructor and Description
VerticalBehaviorDerivatives() Initializes a new instance.
VerticalBehaviorDerivatives(ManeuverReferenceAxes maneuverReferenceAxes, double horizontalAcceleration, double verticalAcceleration) Initializes the vertical derivatives with respect to the indicated maneuver axes.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
static boolean	equals(VerticalBehaviorDerivatives left, VerticalBehaviorDerivatives right) Returns true if the two instances are exactly equal.
boolean	equalsType(VerticalBehaviorDerivatives other) Indicates whether another instance of this type is exactly equal to this instance.
double	getHorizontalAcceleration() Gets the horizontal component of the acceleration.
ManeuverReferenceAxes	getManeuverReferenceAxes() Gets the axes in which the vertical behavior of a maneuver is defined.
double	getVerticalAcceleration() Gets the vertical component of the acceleration.
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(VerticalBehaviorDerivatives left, VerticalBehaviorDerivatives 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

VerticalBehaviorDerivatives

public VerticalBehaviorDerivatives()

Initializes a new instance.

VerticalBehaviorDerivatives

public VerticalBehaviorDerivatives(@Nonnull
                                   ManeuverReferenceAxes maneuverReferenceAxes,
                                   double horizontalAcceleration,
                                   double verticalAcceleration)

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

Parameters:

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

horizontalAcceleration - The horizontal component of the acceleration.

verticalAcceleration - The vertical component of the acceleration.

Method Detail

getManeuverReferenceAxes

@Nonnull
public final ManeuverReferenceAxes getManeuverReferenceAxes()

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

getHorizontalAcceleration

public final double getHorizontalAcceleration()

Gets the horizontal component of the acceleration.

getVerticalAcceleration

public final double getVerticalAcceleration()

Gets the vertical component of the acceleration.

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
                                VerticalBehaviorDerivatives other)

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

Specified by:

equalsType in interface IEquatable<VerticalBehaviorDerivatives>

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
                             VerticalBehaviorDerivatives left,
                             @Nonnull
                             VerticalBehaviorDerivatives 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
                                VerticalBehaviorDerivatives left,
                                @Nonnull
                                VerticalBehaviorDerivatives 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.