agi.foundation.terrain

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

Class ElevationRise

java.lang.Object

agi.foundation.terrain.ElevationRise

All Implemented Interfaces:

IEquatable<ElevationRise>

public class ElevationRise
extends Object
implements IEquatable<ElevationRise>

Describes a rise in obscured elevation angle along a particular azimuth ray of an AzimuthElevationMask.

Constructor Summary

Constructors

Constructor and Description
ElevationRise() Initializes a new instance.
ElevationRise(double distance, double elevation) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(ElevationRise other) Indicates whether another instance of this type is exactly equal to this instance.
double	getDistance() Gets the linear distance at which the maximum obscured elevation angle rise occurs.
double	getElevation() Gets the new maximum obscured elevation angle.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
void	setDistance(double value) Sets the linear distance at which the maximum obscured elevation angle rise occurs.
void	setElevation(double value) Sets the new maximum obscured elevation angle.

Methods inherited from class java.lang.Object

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

Constructor Detail

ElevationRise

public ElevationRise()

Initializes a new instance.

ElevationRise

public ElevationRise(double distance,
                     double elevation)

Initializes a new instance.

Parameters:

distance - The distance, in meters, at which the maximum obscured elevation angle rise occurs.

elevation - The new maximum obscured elevation angle.

Method Detail

getDistance

public final double getDistance()

Gets the linear distance at which the maximum obscured elevation angle rise occurs. The distance is measured from the origin of the mask to the obscured point along the given Elevation (get / set) angle.

setDistance

public final void setDistance(double value)

Sets the linear distance at which the maximum obscured elevation angle rise occurs. The distance is measured from the origin of the mask to the obscured point along the given Elevation (get / set) angle.

getElevation

public final double getElevation()

Gets the new maximum obscured elevation angle.

setElevation

public final void setElevation(double value)

Sets the new maximum obscured elevation angle.

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(ElevationRise other)

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

Specified by:

equalsType in interface IEquatable<ElevationRise>

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)