agi.foundation.routedesign

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

Class ProfileSpeed

java.lang.Object

agi.foundation.routedesign.ProfileSpeed

public class ProfileSpeed
extends Object

A specified target speed provided as either the total horizontal and vertical speed or only the horizontal speed along the surface.

Constructor Summary

Constructors

Constructor and Description
ProfileSpeed(double targetSpeed, SpeedReference reference) Create a new instance with the given target speed, in meters per second.

Method Summary

Modifier and Type	Method and Description
SpeedReference	getSpeedReference() Gets the value indicating whether the TargetSpeed (get) includes the vertical component.
double	getTargetSpeed() Gets the target speed, in meters per second.
boolean	isEquivalent(ProfileSpeed otherSpeed) Checks whether the other instance is equivalent to this one.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfileSpeed

public ProfileSpeed(double targetSpeed,
                    @Nonnull
                    SpeedReference reference)

Create a new instance with the given target speed, in meters per second.

Parameters:

targetSpeed - The target speed, in meters per second.

reference - An enumeration indicating whether the speed includes the vertical component.

Method Detail

getTargetSpeed

public final double getTargetSpeed()

Gets the target speed, in meters per second.

getSpeedReference

@Nonnull
public final SpeedReference getSpeedReference()

Gets the value indicating whether the TargetSpeed (get) includes the vertical component.

isEquivalent

public final boolean isEquivalent(ProfileSpeed otherSpeed)

Checks whether the other instance is equivalent to this one.

Parameters:

otherSpeed - The other dynamics to check.

Returns:

True if the other dynamics has the same target speed and speed reference as this one.