agi.foundation.communications.antennas

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

Class BaseGainPattern

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.antennas.BaseGainPattern

All Implemented Interfaces:

IAntennaGainService, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IServiceProvider

Direct Known Subclasses:

OpticalGainPattern, RadioFrequencyGainPattern

public abstract class BaseGainPattern
extends DefinitionalObject
implements IServiceProvider, IAntennaGainService

Base class for all antenna gain patterns.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseGainPattern() Initializes a new instance.
protected	BaseGainPattern(BaseGainPattern existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	checkForSameDefinition(BaseGainPattern other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
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 based on the given geometry.
Evaluator<Double>	getAntennaGainEvaluator(Vector linkDirection, Axes antennaAxes, Signal sampleSignal) Get an evaluator for the gain that would be applied to the given sample signal based on the given geometry.
abstract 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.
Object	getService(Class<?> serviceType) Gets the service object of the specified type.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseGainPattern

protected BaseGainPattern()

Initializes a new instance.

BaseGainPattern

protected BaseGainPattern(@Nonnull
                          BaseGainPattern existingInstance,
                          @Nonnull
                          CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObject other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class DefinitionalObject

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected abstract boolean checkForSameDefinition(BaseGainPattern other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the BaseGainPattern.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getAntennaGainEvaluator

@Nonnull
public Evaluator<Double> getAntennaGainEvaluator(@Nonnull
                                                           Vector linkDirection,
                                                           @Nonnull
                                                           Axes antennaAxes,
                                                           @Nonnull
                                                           Signal sampleSignal)

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

Parameters:

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.

Throws:

ArgumentNullException - Thrown when linkDirection, antennaAxes, or sampleSignal is null.

getAntennaGainEvaluator

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

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

Specified by:

getAntennaGainEvaluator in interface IAntennaGainService

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.

Throws:

ArgumentNullException - Thrown when group, linkDirection, antennaAxes, or sampleSignal is null.

getApplyAntennaGainEvaluator

@Nonnull
public abstract SignalEvaluator getApplyAntennaGainEvaluator(@Nonnull
                                                                       EvaluatorGroup group,
                                                                       @Nonnull
                                                                       Vector linkDirection,
                                                                       @Nonnull
                                                                       Axes antennaAxes,
                                                                       @Nonnull
                                                                       ISignalSource inputSignal,
                                                                       @Nonnull
                                                                       SignalPropagationGraph graph)

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

Specified by:

getApplyAntennaGainEvaluator in interface IAntennaGainService

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.

Throws:

ArgumentNullException - Thrown when group, linkDirection, antennaAxes, inputSignal, or graph is null.

getService

@Nullable
public Object getService(@Nonnull
                                    Class<?> serviceType)

Gets the service object of the specified type.

Specified by:

getService in interface IServiceProvider

Parameters:

serviceType - An object that specifies the type of service object to get.

Returns:

The found service, or null if the service does not exist.

Throws:

ArgumentNullException - Thrown when serviceType is null.