agi.foundation.communications.signalpropagation

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

Class TiremPropagationData

java.lang.Object

agi.foundation.communications.signalpropagation.TiremPropagationData

Direct Known Subclasses:

TiremPropagationModel.PropagationData, TiremPropagationModel3_18.PropagationData

public class TiremPropagationData
extends Object

Contains the values returned from the TIREM propagation. Subclasses may contain additional data produced by the specific implementation of TIREM being used.

Constructor Summary

Constructors

Constructor and Description

TiremPropagationData(String version, double absorptionLoss, double diffractionLoss, double freeSpaceLoss, double troposcatterLoss, double totalPathLoss, TiremPropagationMode propagationMode, double receiverAngleTroposcatterTriangle, double transmitterAngleTroposcatterTriangle, int receiverHorizon, int transmitterHorizon, double receiverHorizonAngle, double transmitterHorizonAngle, double troposcatterAngle) Defines a set of TIREM propagated data.

Method Summary

Modifier and Type	Method and Description
double	getAbsorptionLoss() Gets the loss due to atmospheric absorption, in dB.
double	getDiffractionLoss() Gets the diffraction loss, in dB.
double	getFreeSpaceLoss() Gets the free space loss, in dB.
TiremPropagationMode	getPropagationMode() Gets the dominant propagation mode used in the propagation.
double	getReceiverAngleTroposcatterTriangle() Gets the angle at the receiver in the troposcatter triangle, in radians.
int	getReceiverHorizon() Gets the index of the profile point where the receiver's horizon occurs.
double	getReceiverHorizonAngle() Gets the receiver horizon angle, in radians.
double	getTotalPathLoss() Gets the total path loss, in dB.
double	getTransmitterAngleTroposcatterTriangle() Gets the angle at the transmitter in the troposcatter triangle, in radians.
int	getTransmitterHorizon() Gets the index of the profile point where the transmitter's horizon occurs.
double	getTransmitterHorizonAngle() Gets the transmitter horizon angle, in radians.
double	getTroposcatterAngle() Gets the troposcatter angle, in radians.
double	getTroposcatterLoss() Gets the troposcatter loss, in dB.
String	getVersion() Gets the version of TIREM reporting these results.

Methods inherited from class java.lang.Object

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

Constructor Detail

TiremPropagationData

public TiremPropagationData(String version,
                            double absorptionLoss,
                            double diffractionLoss,
                            double freeSpaceLoss,
                            double troposcatterLoss,
                            double totalPathLoss,
                            @Nonnull
                            TiremPropagationMode propagationMode,
                            double receiverAngleTroposcatterTriangle,
                            double transmitterAngleTroposcatterTriangle,
                            int receiverHorizon,
                            int transmitterHorizon,
                            double receiverHorizonAngle,
                            double transmitterHorizonAngle,
                            double troposcatterAngle)

Defines a set of TIREM propagated data.

Parameters:

version - The version of TIREM reporting these results.

absorptionLoss - The loss due to atmospheric absorption, in dB.

diffractionLoss - The diffraction loss, in dB.

freeSpaceLoss - The free space loss, in dB.

troposcatterLoss - The troposcatter loss, in dB.

totalPathLoss - The total path loss, in dB.

propagationMode - The dominant propagation mode used in the propagation.

receiverAngleTroposcatterTriangle - The angle at the receiver in the troposcatter triangle, in radians.

transmitterAngleTroposcatterTriangle - The angle at the transmitter in the troposcatter triangle, in radians.

receiverHorizon - The index of the profile point where the receiver's horizon occurs.

transmitterHorizon - The index of the profile point where the transmitter's horizon occurs.

receiverHorizonAngle - The receiver horizon angle, in radians.

transmitterHorizonAngle - The transmitter horizon angle, in radians.

troposcatterAngle - The troposcatter angle, in radians.

Method Detail

getVersion

public final String getVersion()

Gets the version of TIREM reporting these results.

getAbsorptionLoss

public final double getAbsorptionLoss()

Gets the loss due to atmospheric absorption, in dB.

getDiffractionLoss

public final double getDiffractionLoss()

Gets the diffraction loss, in dB.

getFreeSpaceLoss

public final double getFreeSpaceLoss()

Gets the free space loss, in dB.

getTroposcatterLoss

public final double getTroposcatterLoss()

Gets the troposcatter loss, in dB.

getTotalPathLoss

public final double getTotalPathLoss()

Gets the total path loss, in dB.

getPropagationMode

@Nonnull
public final TiremPropagationMode getPropagationMode()

Gets the dominant propagation mode used in the propagation.

getReceiverAngleTroposcatterTriangle

public final double getReceiverAngleTroposcatterTriangle()

Gets the angle at the receiver in the troposcatter triangle, in radians.

getTransmitterAngleTroposcatterTriangle

public final double getTransmitterAngleTroposcatterTriangle()

Gets the angle at the transmitter in the troposcatter triangle, in radians.

getReceiverHorizon

public final int getReceiverHorizon()

Gets the index of the profile point where the receiver's horizon occurs.

getTransmitterHorizon

public final int getTransmitterHorizon()

Gets the index of the profile point where the transmitter's horizon occurs.

getReceiverHorizonAngle

public final double getReceiverHorizonAngle()

Gets the receiver horizon angle, in radians.

getTransmitterHorizonAngle

public final double getTransmitterHorizonAngle()

Gets the transmitter horizon angle, in radians.

getTroposcatterAngle

public final double getTroposcatterAngle()

Gets the troposcatter angle, in radians.