agi.foundation.communications

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

Class LinkBudgetScalars

java.lang.Object

agi.foundation.communications.LinkBudgetScalars

Direct Known Subclasses:

GnssLinkBudgetScalars

public class LinkBudgetScalars
extends Object

Defines a link budget over time.

Constructor Summary

Constructors

Constructor and Description
LinkBudgetScalars(ScalarAntennaGainInLinkDirection transmitterAntennaGainInLinkDirection, ScalarAntennaGainInLinkDirection receiverAntennaGainInLinkDirection, ScalarBitErrorRate<DigitalModulation> bitErrorRate, ScalarCarrierToInterference carrierToInterference, ScalarCarrierToNoise carrierToNoise, ScalarCarrierToNoiseDensity carrierToNoiseDensity, ScalarCarrierToNoisePlusInterference carrierToNoisePlusInterference, ScalarEffectiveIsotropicRadiatedPower effectiveIsotropicRadiatedPower, ScalarEnergyPerBitToNoiseDensity<DigitalModulation> energyPerBitToNoiseDensity, ScalarPowerAtReceiverOutput powerAtReceiverOutput, ScalarPropagationLoss propagationLoss, ScalarReceivedIsotropicPower receivedIsotropicPower, ScalarReceivedPowerFluxDensity receivedPowerFluxDensity) Initializes a new instance.
LinkBudgetScalars(ScalarAntennaGainInLinkDirection transmitterAntennaGainInLinkDirection, ScalarAntennaGainInLinkDirection receiverAntennaGainInLinkDirection, ScalarBitErrorRate<DigitalModulation> bitErrorRate, ScalarCarrierToInterference carrierToInterference, ScalarCarrierToNoise carrierToNoise, ScalarCarrierToNoiseDensity carrierToNoiseDensity, ScalarCarrierToNoisePlusInterference carrierToNoisePlusInterference, ScalarEffectiveIsotropicRadiatedPower effectiveIsotropicRadiatedPower, ScalarEnergyPerBitToNoiseDensity<DigitalModulation> energyPerBitToNoiseDensity, ScalarPowerAtReceiverOutput powerAtReceiverOutput, ScalarPropagationLoss propagationLoss, ScalarReceivedIsotropicPower receivedIsotropicPower, ScalarReceivedPowerFluxDensity receivedPowerFluxDensity, String linkName) Initializes a new instance.
LinkBudgetScalars(ScalarAntennaGainInLinkDirection transmitterAntennaGainInLinkDirection, ScalarAntennaGainInLinkDirection receiverAntennaGainInLinkDirection, ScalarBitErrorRate<DigitalModulation> bitErrorRate, ScalarCarrierToInterference carrierToInterference, ScalarCarrierToNoise carrierToNoise, ScalarCarrierToNoiseDensity carrierToNoiseDensity, ScalarCarrierToNoisePlusInterference carrierToNoisePlusInterference, ScalarEffectiveIsotropicRadiatedPower effectiveIsotropicRadiatedPower, ScalarEnergyPerBitToNoiseDensity<DigitalModulation> energyPerBitToNoiseDensity, ScalarPowerAtReceiverOutput powerAtReceiverOutput, ScalarPropagationLoss propagationLoss, ScalarReceivedIsotropicPower receivedIsotropicPower, ScalarReceivedPowerFluxDensity receivedPowerFluxDensity, String linkName, ArrayList<ScalarPropagationLoss> propagationLossPerModel) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
ScalarBitErrorRate<DigitalModulation>	getBitErrorRate() Gets the bit error rate.
ScalarCarrierToInterference	getCarrierToInterference() Gets the carrier to interference ratio.
ScalarCarrierToNoise	getCarrierToNoise() Gets the carrier to noise ratio.
ScalarCarrierToNoiseDensity	getCarrierToNoiseDensity() Gets the carrier to noise density.
ScalarCarrierToNoisePlusInterference	getCarrierToNoisePlusInterference() Gets the carrier to noise plus interference ratio.
ScalarEffectiveIsotropicRadiatedPower	getEffectiveIsotropicRadiatedPower() Gets the effective isotropic radiated power.
ScalarEnergyPerBitToNoiseDensity<DigitalModulation>	getEnergyPerBitToNoiseDensity() Gets the energy per bit to noise density.
String	getLinkName() Gets the name of the link producing these scalars, if available.
ScalarPowerAtReceiverOutput	getPowerAtReceiverOutput() Gets the power at receiver output.
ScalarPropagationLoss	getPropagationLoss() Gets the amount of propagation loss.
ArrayList<ScalarPropagationLoss>	getPropagationLossPerModel() Gets the amount of propagation loss per propagation model, if available.
ScalarReceivedIsotropicPower	getReceivedIsotropicPower() Gets the received isotropic power.
ScalarReceivedPowerFluxDensity	getReceivedPowerFluxDensity() Gets the received power flux density.
ScalarAntennaGainInLinkDirection	getReceiverAntennaGainInLinkDirection() Gets the receiver antenna gain in the link direction.
ScalarAntennaGainInLinkDirection	getTransmitterAntennaGainInLinkDirection() Gets the transmitter antenna gain in the link direction.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkBudgetScalars

public LinkBudgetScalars(ScalarAntennaGainInLinkDirection transmitterAntennaGainInLinkDirection,
                         ScalarAntennaGainInLinkDirection receiverAntennaGainInLinkDirection,
                         ScalarBitErrorRate<DigitalModulation> bitErrorRate,
                         ScalarCarrierToInterference carrierToInterference,
                         ScalarCarrierToNoise carrierToNoise,
                         ScalarCarrierToNoiseDensity carrierToNoiseDensity,
                         ScalarCarrierToNoisePlusInterference carrierToNoisePlusInterference,
                         ScalarEffectiveIsotropicRadiatedPower effectiveIsotropicRadiatedPower,
                         ScalarEnergyPerBitToNoiseDensity<DigitalModulation> energyPerBitToNoiseDensity,
                         ScalarPowerAtReceiverOutput powerAtReceiverOutput,
                         ScalarPropagationLoss propagationLoss,
                         ScalarReceivedIsotropicPower receivedIsotropicPower,
                         ScalarReceivedPowerFluxDensity receivedPowerFluxDensity)

Initializes a new instance.

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.

LinkBudgetScalars

public LinkBudgetScalars(ScalarAntennaGainInLinkDirection transmitterAntennaGainInLinkDirection,
                         ScalarAntennaGainInLinkDirection receiverAntennaGainInLinkDirection,
                         ScalarBitErrorRate<DigitalModulation> bitErrorRate,
                         ScalarCarrierToInterference carrierToInterference,
                         ScalarCarrierToNoise carrierToNoise,
                         ScalarCarrierToNoiseDensity carrierToNoiseDensity,
                         ScalarCarrierToNoisePlusInterference carrierToNoisePlusInterference,
                         ScalarEffectiveIsotropicRadiatedPower effectiveIsotropicRadiatedPower,
                         ScalarEnergyPerBitToNoiseDensity<DigitalModulation> energyPerBitToNoiseDensity,
                         ScalarPowerAtReceiverOutput powerAtReceiverOutput,
                         ScalarPropagationLoss propagationLoss,
                         ScalarReceivedIsotropicPower receivedIsotropicPower,
                         ScalarReceivedPowerFluxDensity receivedPowerFluxDensity,
                         String linkName)

Initializes a new instance.

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.

linkName - The name of the link producing these scalars.

LinkBudgetScalars

public LinkBudgetScalars(ScalarAntennaGainInLinkDirection transmitterAntennaGainInLinkDirection,
                         ScalarAntennaGainInLinkDirection receiverAntennaGainInLinkDirection,
                         ScalarBitErrorRate<DigitalModulation> bitErrorRate,
                         ScalarCarrierToInterference carrierToInterference,
                         ScalarCarrierToNoise carrierToNoise,
                         ScalarCarrierToNoiseDensity carrierToNoiseDensity,
                         ScalarCarrierToNoisePlusInterference carrierToNoisePlusInterference,
                         ScalarEffectiveIsotropicRadiatedPower effectiveIsotropicRadiatedPower,
                         ScalarEnergyPerBitToNoiseDensity<DigitalModulation> energyPerBitToNoiseDensity,
                         ScalarPowerAtReceiverOutput powerAtReceiverOutput,
                         ScalarPropagationLoss propagationLoss,
                         ScalarReceivedIsotropicPower receivedIsotropicPower,
                         ScalarReceivedPowerFluxDensity receivedPowerFluxDensity,
                         String linkName,
                         ArrayList<ScalarPropagationLoss> propagationLossPerModel)

Initializes a new instance.

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.

linkName - The name of the link producing these scalars.

propagationLossPerModel - A list of scalars that compute the amount of propagation loss per propagation model.

Method Detail

getTransmitterAntennaGainInLinkDirection

public final ScalarAntennaGainInLinkDirection getTransmitterAntennaGainInLinkDirection()

Gets the transmitter antenna gain in the link direction.

getReceiverAntennaGainInLinkDirection

public final ScalarAntennaGainInLinkDirection getReceiverAntennaGainInLinkDirection()

Gets the receiver antenna gain in the link direction.

getBitErrorRate

public final ScalarBitErrorRate<DigitalModulation> getBitErrorRate()

Gets the bit error rate.

getCarrierToInterference

public final ScalarCarrierToInterference getCarrierToInterference()

Gets the carrier to interference ratio.

getCarrierToNoise

public final ScalarCarrierToNoise getCarrierToNoise()

Gets the carrier to noise ratio.

getCarrierToNoiseDensity

public final ScalarCarrierToNoiseDensity getCarrierToNoiseDensity()

Gets the carrier to noise density.

getCarrierToNoisePlusInterference

public final ScalarCarrierToNoisePlusInterference getCarrierToNoisePlusInterference()

Gets the carrier to noise plus interference ratio.

getEffectiveIsotropicRadiatedPower

public final ScalarEffectiveIsotropicRadiatedPower getEffectiveIsotropicRadiatedPower()

Gets the effective isotropic radiated power.

getEnergyPerBitToNoiseDensity

public final ScalarEnergyPerBitToNoiseDensity<DigitalModulation> getEnergyPerBitToNoiseDensity()

Gets the energy per bit to noise density.

getPowerAtReceiverOutput

public final ScalarPowerAtReceiverOutput getPowerAtReceiverOutput()

Gets the power at receiver output.

getPropagationLoss

public final ScalarPropagationLoss getPropagationLoss()

Gets the amount of propagation loss.

getPropagationLossPerModel

@Nullable
public final ArrayList<ScalarPropagationLoss> getPropagationLossPerModel()

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

getReceivedIsotropicPower

public final ScalarReceivedIsotropicPower getReceivedIsotropicPower()

Gets the received isotropic power.

getReceivedPowerFluxDensity

public final ScalarReceivedPowerFluxDensity getReceivedPowerFluxDensity()

Gets the received power flux density.

getLinkName

@Nullable
public final String getLinkName()

Gets the name of the link producing these scalars, if available.