agi.foundation.tirem

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

Class TiremTerrainProfile

java.lang.Object

agi.foundation.tirem.TiremTerrainProfile

public final class TiremTerrainProfile
extends Object

Represents terrain profile information that will be provided to the TIREM calculation.

Constructor Summary

Constructors

Constructor and Description
TiremTerrainProfile(double transmitterHeight, double receiverHeight, double[] heights, double[] distances) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
double[]	getDistances() Gets the array of great circle distances from the beginning of the profile to each profile point in meters.
double[]	getHeights() Gets the array of profile terrain heights above mean sea level in meters.
double	getReceiverHeight() Gets the receiver structural antenna height in meters.
double	getTransmitterHeight() Gets the transmitter structural antenna height in meters.

Methods inherited from class java.lang.Object

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

Constructor Detail

TiremTerrainProfile

public TiremTerrainProfile(double transmitterHeight,
                           double receiverHeight,
                           @Nonnull
                           double[] heights,
                           @Nonnull
                           double[] distances)

Initializes a new instance.

Parameters:

transmitterHeight - The transmitter structural antenna height in meters.

receiverHeight - The receiver structural antenna height in meters.

heights - An array of profile terrain heights above mean sea level in meters.

distances - An array of great circle distances from the beginning of the profile to each profile point in meters.

Throws:

ArgumentNullException - Thrown when heights or distances is null.

Method Detail

getTransmitterHeight

public final double getTransmitterHeight()

Gets the transmitter structural antenna height in meters.

getReceiverHeight

public final double getReceiverHeight()

Gets the receiver structural antenna height in meters.

getHeights

@Nonnull
public final double[] getHeights()

Gets the array of profile terrain heights above mean sea level in meters.

getDistances

@Nonnull
public final double[] getDistances()

Gets the array of great circle distances from the beginning of the profile to each profile point in meters.