agi.foundation.communications

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

Class LinkBudget

java.lang.Object

agi.foundation.communications.LinkBudget

public class LinkBudget
extends Object

Defines a link budget at a single instance in time.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LinkBudget.SignalPropagationModelLoss Stores the amount of propagation loss for a single SignalPropagationModel.

Constructor Summary

Constructors

Constructor and Description
LinkBudget(double transmitterAntennaGainInLinkDirection, double receiverAntennaGainInLinkDirection, double bitErrorRate, double carrierToInterference, double carrierToNoise, double carrierToNoiseDensity, double carrierToNoisePlusInterference, double effectiveIsotropicRadiatedPower, double energyPerBitToNoiseDensity, double powerAtReceiverOutput, double propagationLoss, double receivedIsotropicPower, double receivedPowerFluxDensity) Creates a new instance specifying all standard parameters.
LinkBudget(double transmitterAntennaGainInLinkDirection, double receiverAntennaGainInLinkDirection, double bitErrorRate, double carrierToInterference, double carrierToNoise, double carrierToNoiseDensity, double carrierToNoisePlusInterference, double effectiveIsotropicRadiatedPower, double energyPerBitToNoiseDensity, double powerAtReceiverOutput, double propagationLoss, double receivedIsotropicPower, double receivedPowerFluxDensity, ArrayList<LinkBudget.SignalPropagationModelLoss> propagationLossPerModel) Creates a new instance specifying all parameters.

Method Summary

Modifier and Type	Method and Description
double	getBitErrorRate() Gets the bit error rate.
double	getCarrierToInterference() Gets the carrier to interference ratio.
double	getCarrierToNoise() Gets the carrier to noise ratio.
double	getCarrierToNoiseDensity() Gets the carrier to noise density.
double	getCarrierToNoisePlusInterference() Gets the carrier to noise plus interference ratio.
double	getEffectiveIsotropicRadiatedPower() Gets the effective isotropic radiated power.
double	getEnergyPerBitToNoiseDensity() Gets the energy per bit to noise density.
double	getPowerAtReceiverOutput() Gets the power at receiver output.
double	getPropagationLoss() Gets the amount of propagation loss.
ArrayList<LinkBudget.SignalPropagationModelLoss>	getPropagationLossPerModel() Gets the amount of propagation loss per SignalPropagationModel, if available.
double	getReceivedIsotropicPower() Gets the received isotropic power.
double	getReceivedPowerFluxDensity() Gets the received power flux density.
double	getReceiverAntennaGainInLinkDirection() Gets the receiver antenna gain in the link direction.
double	getTransmitterAntennaGainInLinkDirection() Gets the transmitter antenna gain in the link direction.
String	toString() Returns a string which represents the current LinkBudget.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkBudget

public LinkBudget(double transmitterAntennaGainInLinkDirection,
                  double receiverAntennaGainInLinkDirection,
                  double bitErrorRate,
                  double carrierToInterference,
                  double carrierToNoise,
                  double carrierToNoiseDensity,
                  double carrierToNoisePlusInterference,
                  double effectiveIsotropicRadiatedPower,
                  double energyPerBitToNoiseDensity,
                  double powerAtReceiverOutput,
                  double propagationLoss,
                  double receivedIsotropicPower,
                  double receivedPowerFluxDensity)

Creates a new instance specifying all standard parameters.

Parameters:

transmitterAntennaGainInLinkDirection - The transmitter antenna gain in the link direction.

receiverAntennaGainInLinkDirection - The receiver antenna gain in the link direction.

bitErrorRate - The bit error rate.

carrierToInterference - The carrier to interference ratio.

carrierToNoise - The carrier to noise ratio.

carrierToNoiseDensity - The carrier to noise density ratio.

carrierToNoisePlusInterference - The carrier to noise plus interference ratio.

effectiveIsotropicRadiatedPower - The effective isotropic radiated power.

energyPerBitToNoiseDensity - The energy per bit to noise density.

powerAtReceiverOutput - The power at receiver output.

propagationLoss - The propagation loss.

receivedIsotropicPower - The received isotropic power.

receivedPowerFluxDensity - The received power flux density.

LinkBudget

public LinkBudget(double transmitterAntennaGainInLinkDirection,
                  double receiverAntennaGainInLinkDirection,
                  double bitErrorRate,
                  double carrierToInterference,
                  double carrierToNoise,
                  double carrierToNoiseDensity,
                  double carrierToNoisePlusInterference,
                  double effectiveIsotropicRadiatedPower,
                  double energyPerBitToNoiseDensity,
                  double powerAtReceiverOutput,
                  double propagationLoss,
                  double receivedIsotropicPower,
                  double receivedPowerFluxDensity,
                  ArrayList<LinkBudget.SignalPropagationModelLoss> propagationLossPerModel)

Creates a new instance specifying all parameters.

Parameters:

transmitterAntennaGainInLinkDirection - The transmitter antenna gain in the link direction.

receiverAntennaGainInLinkDirection - The receiver antenna gain in the link direction.

bitErrorRate - The bit error rate.

carrierToInterference - The carrier to interference ratio.

carrierToNoise - The carrier to noise ratio.

carrierToNoiseDensity - The carrier to noise density ratio.

carrierToNoisePlusInterference - The carrier to noise plus interference ratio.

effectiveIsotropicRadiatedPower - The effective isotropic radiated power.

energyPerBitToNoiseDensity - The energy per bit to noise density.

powerAtReceiverOutput - The power at receiver output.

propagationLoss - The propagation loss.

receivedIsotropicPower - The received isotropic power.

receivedPowerFluxDensity - The received power flux density.

propagationLossPerModel - The detailed propagation losses per signal propagation model.

Method Detail

getTransmitterAntennaGainInLinkDirection

public final double getTransmitterAntennaGainInLinkDirection()

Gets the transmitter antenna gain in the link direction.

getReceiverAntennaGainInLinkDirection

public final double getReceiverAntennaGainInLinkDirection()

Gets the receiver antenna gain in the link direction.

getBitErrorRate

public final double getBitErrorRate()

Gets the bit error rate.

getCarrierToInterference

public final double getCarrierToInterference()

Gets the carrier to interference ratio.

getCarrierToNoise

public final double getCarrierToNoise()

Gets the carrier to noise ratio.

getCarrierToNoiseDensity

public final double getCarrierToNoiseDensity()

Gets the carrier to noise density.

getCarrierToNoisePlusInterference

public final double getCarrierToNoisePlusInterference()

Gets the carrier to noise plus interference ratio.

getEffectiveIsotropicRadiatedPower

public final double getEffectiveIsotropicRadiatedPower()

Gets the effective isotropic radiated power.

getEnergyPerBitToNoiseDensity

public final double getEnergyPerBitToNoiseDensity()

Gets the energy per bit to noise density.

getPowerAtReceiverOutput

public final double getPowerAtReceiverOutput()

Gets the power at receiver output.

getPropagationLoss

public final double getPropagationLoss()

Gets the amount of propagation loss.

getPropagationLossPerModel

@Nullable
public final ArrayList<LinkBudget.SignalPropagationModelLoss> getPropagationLossPerModel()

Gets the amount of propagation loss per SignalPropagationModel, if available.

getReceivedIsotropicPower

public final double getReceivedIsotropicPower()

Gets the received isotropic power.

getReceivedPowerFluxDensity

public final double getReceivedPowerFluxDensity()

Gets the received power flux density.

toString

public String toString()

Returns a string which represents the current LinkBudget.

Overrides:

toString in class Object

Returns:

A string which represents the current LinkBudget, in linear and dB units.