agi.foundation.aircraftpropagation

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

Class ClimbDescentCommandedValues

java.lang.Object

agi.foundation.aircraftpropagation.ClimbDescentCommandedValues

All Implemented Interfaces:

IEquatable<ClimbDescentCommandedValues>, ImmutableValueType, ValueType

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

Defines the commanded performance values during climb or descent.

Constructor Summary

Constructors

Constructor and Description
ClimbDescentCommandedValues() Initializes a new instance.
ClimbDescentCommandedValues(double trueAirspeed, double altitudeRate, double fuelFlowRate) Initializes an instance with the provided parameters.

Method Summary

Modifier and Type	Method and Description
static boolean	equals(ClimbDescentCommandedValues left, ClimbDescentCommandedValues 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(ClimbDescentCommandedValues other) Indicates whether another instance of this type is exactly equal to this instance.
double	getAirspeed() Gets the commanded airspeed.
double	getAltitudeRate() Gets the commanded rate of altitude change.
double	getFuelFlowRate() Gets the commanded rate of fuel flow.
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(ClimbDescentCommandedValues left, ClimbDescentCommandedValues 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

ClimbDescentCommandedValues

public ClimbDescentCommandedValues()

Initializes a new instance.

ClimbDescentCommandedValues

public ClimbDescentCommandedValues(double trueAirspeed,
                                   double altitudeRate,
                                   double fuelFlowRate)

Initializes an instance with the provided parameters.

Parameters:

trueAirspeed - The commanded true airspeed.

altitudeRate - The commanded rate of altitude change.

fuelFlowRate - The commanded rate of fuel flow.

Method Detail

getAirspeed

public final double getAirspeed()

Gets the commanded airspeed.

getAltitudeRate

public final double getAltitudeRate()

Gets the commanded rate of altitude change. Positive values indicate climb, and negative values indicate descent.

getFuelFlowRate

public final double getFuelFlowRate()

Gets the commanded rate of fuel flow.

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

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

Specified by:

equalsType in interface IEquatable<ClimbDescentCommandedValues>

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