agi.foundation.communications.antennas

(agi.foundation.communications-2025r1.jar)

Interface IAntennaGainService

All Known Implementing Classes:

AnsysHfssFarFieldDataGainPattern, BaseGainPattern, BesselCircularApertureGainPattern, BesselEnvelopeCircularApertureGainPattern, CosineCircularApertureGainPattern, CosinePedestalCircularApertureGainPattern, CosinePedestalRectangularApertureGainPattern, CosineRectangularApertureGainPattern, CosineSquaredCircularApertureGainPattern, CosineSquaredPedestalCircularApertureGainPattern, CosineSquaredPedestalRectangularApertureGainPattern, CosineSquaredRectangularApertureGainPattern, CustomGainPattern, DipoleGainPattern, FrequencyDependentElectricFieldGainPattern, FrpaGainPattern, GaussianGainPattern, GaussianOpticalGainPattern, GpsSatelliteAntennaPattern, HelicalGainPattern, HemisphericalGainPattern, IsotropicGainPattern, ItuRBO1213Version1CoPolarGainPattern, ItuRBO1213Version1CrossPolarGainPattern, ItuRF1245Version1GainPattern, ItuRF1245Version3GainPattern, ItuRS1528R12GainPattern, ItuRS1528R13GainPattern, ItuRS465Version5GainPattern, ItuRS465Version6GainPattern, ItuRS580Version6GainPattern, ItuRS672Version4GainPattern, ItuRS731Version1GainPattern, OpticalGainPattern, ParabolicGainPattern, PencilBeamGainPattern, PhasedArrayGainPattern, RadioFrequencyGainPattern, RectangularBeamGainPattern, SincExponentCircularApertureGainPattern, SincExponentRectangularApertureGainPattern, SquareHornGainPattern, UniformCircularApertureGainPattern, UniformRectangularApertureGainPattern

public interface IAntennaGainService

Defines a service which can provide a means of applying an antenna pattern to a set of input signals based on link geometry.

Method Summary

Modifier and Type	Method and Description
Evaluator<Double>	getAntennaGainEvaluator(EvaluatorGroup group, Vector linkDirection, Axes antennaAxes, Signal sampleSignal) Get an evaluator for the gain that would be applied to the given sample signal.
SignalEvaluator	getApplyAntennaGainEvaluator(EvaluatorGroup group, Vector linkDirection, Axes antennaAxes, ISignalSource inputSignal, SignalPropagationGraph graph) Get an evaluator which can modify a set of input signals based on link geometry and the gain pattern.

Method Detail

getAntennaGainEvaluator

Evaluator<Double> getAntennaGainEvaluator(EvaluatorGroup group,
                                          Vector linkDirection,
                                          Axes antennaAxes,
                                          Signal sampleSignal)

Get an evaluator for the gain that would be applied to the given sample signal.

Parameters:

group - The evaluator group in which to create the evaluator.

linkDirection - The direction of the link relative to the antenna axes.

antennaAxes - The orientation of the antenna.

sampleSignal - A sample input signal.

Returns:

An evaluator which produces the antenna gain.

getApplyAntennaGainEvaluator

SignalEvaluator getApplyAntennaGainEvaluator(EvaluatorGroup group,
                                             Vector linkDirection,
                                             Axes antennaAxes,
                                             ISignalSource inputSignal,
                                             SignalPropagationGraph graph)

Get an evaluator which can modify a set of input signals based on link geometry and the gain pattern.

Parameters:

group - The evaluator group in which to create the evaluator.

linkDirection - The direction of the link relative to the antenna axes.

antennaAxes - The orientation of the antenna.

inputSignal - The source for the signals on which to apply the gain.

graph - The graph of communication links to use in the analysis.

Returns:

An evaluator which produces the modified set of signals with gains applied.