agi.foundation.coverage.figureofmerit

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

Class CommunicationFigureOfMerit

java.lang.Object

agi.foundation.coverage.figureofmerit.CommunicationFigureOfMerit

All Implemented Interfaces:

IFigureOfMeritDefinition

public class CommunicationFigureOfMerit
extends Object
implements IFigureOfMeritDefinition

A figure of merit based on a CommunicationObjectScalar representing a link budget parameter or other communication related value.

Constructor Summary

Constructors

Constructor and Description
CommunicationFigureOfMerit() Initializes a new instance.
CommunicationFigureOfMerit(CommunicationObjectScalar communicationParameter) Initialize a new instance based on the given scalar communication parameter.

Method Summary

Modifier and Type	Method and Description
CommunicationObjectScalar	getCommunicationParameter() Gets the scalar communication parameter to use as a template for this figure of merit.
Scalar	getScalarFigureOfMerit(ValueDefinition<CoverageData> coverageResult, IServiceProvider coverageObject) Get a Scalar representing a figure of merit based on the given CommunicationParameter (get / set).
void	setCommunicationParameter(CommunicationObjectScalar value) Sets the scalar communication parameter to use as a template for this figure of merit.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommunicationFigureOfMerit

public CommunicationFigureOfMerit()

Initializes a new instance.

CommunicationFigureOfMerit

public CommunicationFigureOfMerit(CommunicationObjectScalar communicationParameter)

Initialize a new instance based on the given scalar communication parameter.

Parameters:

communicationParameter - The scalar communication parameter to use as a figure of merit.

Method Detail

getCommunicationParameter

public final CommunicationObjectScalar getCommunicationParameter()

Gets the scalar communication parameter to use as a template for this figure of merit. The instances of the IServiceProvider representing the receiver will be replaced with the coverage object when producing the Scalar representing the figure of merit.

setCommunicationParameter

public final void setCommunicationParameter(CommunicationObjectScalar value)

Sets the scalar communication parameter to use as a template for this figure of merit. The instances of the IServiceProvider representing the receiver will be replaced with the coverage object when producing the Scalar representing the figure of merit.

getScalarFigureOfMerit

public final Scalar getScalarFigureOfMerit(ValueDefinition<CoverageData> coverageResult,
                                           IServiceProvider coverageObject)

Get a Scalar representing a figure of merit based on the given CommunicationParameter (get / set). All instances of the CoverageData.GridPointPlaceholder used in the CommunicationParameter (get / set) will be replaced with the coverageObject in the new scalar.

Specified by:

getScalarFigureOfMerit in interface IFigureOfMeritDefinition

Parameters:

coverageResult - The result of a coverage calculation for the given coverageObject.

coverageObject - The object of interest in the coverage calculation, which will replace the placeholder in the CommunicationParameter (get / set).

Returns:

A Scalar representing the figure of merit for the given CommunicationParameter (get / set).