agi.foundation.communications.antennas

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

Class PencilBeamGainPattern

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.antennas.BaseGainPattern

agi.foundation.communications.antennas.RadioFrequencyGainPattern

agi.foundation.communications.antennas.PencilBeamGainPattern

All Implemented Interfaces:

IAntennaGainService, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IServiceProvider

public class PencilBeamGainPattern
extends RadioFrequencyGainPattern

A circular antenna beam with constant gain specified by the MainLobeGain (get / set) property over the desired beamwidth and SideLobeGain (get / set) for all other angles.

Constructor Summary

Constructors

Modifier	Constructor and Description
	PencilBeamGainPattern() Initializes a new instance.
	PencilBeamGainPattern(double mainLobeGain, double beamwidth) Initializes a new instance with a desired main lobe gain and beamwidth.
protected	PencilBeamGainPattern(PencilBeamGainPattern existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(PencilBeamGainPattern other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(RadioFrequencyGainPattern other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
void	configureMainLobeGainAndBeamwidth(double mainLobeGain, double beamwidth) Helper function for configuring the side lobe gain for a given main lobe gain and desired beamwidth.
SignalEvaluator	getApplyAntennaGainEvaluator(EvaluatorGroup group, Vector linkDirection, Axes antennaAxes, ISignalSource inputSignal, SignalPropagationGraph graph) Get an evaluator which can modify a set of signals based on link geometry and this gain pattern.
double	getMainLobeGain() Gets the main lobe gain.
double	getSideLobeGain() Gets the side lobe gain.
void	setMainLobeGain(double value) Sets the main lobe gain.
void	setSideLobeGain(double value) Sets the side lobe gain.

Methods inherited from class agi.foundation.communications.antennas.RadioFrequencyGainPattern

checkForSameDefinition

Methods inherited from class agi.foundation.communications.antennas.BaseGainPattern

checkForSameDefinition, getAntennaGainEvaluator, getAntennaGainEvaluator, getService

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, 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

PencilBeamGainPattern

public PencilBeamGainPattern()

Initializes a new instance.

Table of property default values.

Property	Default Value
MainLobeGain (get / set)	10000.0
SideLobeGain (get / set)	0.5

PencilBeamGainPattern

public PencilBeamGainPattern(double mainLobeGain,
                             double beamwidth)

Initializes a new instance with a desired main lobe gain and beamwidth.

Parameters:

mainLobeGain - The pencil beam main lobe gain.

beamwidth - The desired beamwidth of the pencil beam antenna, in radians.

Throws:

ArgumentException - Thrown when beamwidth is less than or equal to 0.0 or greater than π/2 radians, or mainLobeGain is less than or equal to 1.0.

PencilBeamGainPattern

protected PencilBeamGainPattern(@Nonnull
                                PencilBeamGainPattern 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

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final boolean checkForSameDefinition(RadioFrequencyGainPattern 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 RadioFrequencyGainPattern

Parameters:

other - The other instance to compare to this one.

Returns:

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

checkForSameDefinition

protected boolean checkForSameDefinition(PencilBeamGainPattern 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 PencilBeamGainPattern.checkForSameDefinition(agi.foundation.communications.antennas.RadioFrequencyGainPattern) method.

Overrides:

computeCurrentDefinitionHashCode in class RadioFrequencyGainPattern

Returns:

The computed hash code.

getApplyAntennaGainEvaluator

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

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

Specified by:

getApplyAntennaGainEvaluator in interface IAntennaGainService

Specified by:

getApplyAntennaGainEvaluator in class BaseGainPattern

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 set of input signals.

graph - The communication graph.

Returns:

Returns inputSignal without applying a gain.

Throws:

PropertyInvalidException - Thrown when MainLobeGain (get / set) is less than or equal to 1.0, or when SideLobeGain (get / set) is less than or equal to zero, or when SideLobeGain (get / set) is greater than or equal to MainLobeGain (get / set), or when SideLobeGain (get / set) produces an invalid beamwidth value.

getMainLobeGain

public final double getMainLobeGain()

Gets the main lobe gain.

Defaults to a value of 10000.0.

setMainLobeGain

public final void setMainLobeGain(double value)

Sets the main lobe gain.

Defaults to a value of 10000.0.

getSideLobeGain

public final double getSideLobeGain()

Gets the side lobe gain.

Defaults to a value of 0.5.

setSideLobeGain

public final void setSideLobeGain(double value)

Sets the side lobe gain.

Defaults to a value of 0.5.

configureMainLobeGainAndBeamwidth

public final void configureMainLobeGainAndBeamwidth(double mainLobeGain,
                                                    double beamwidth)

Helper function for configuring the side lobe gain for a given main lobe gain and desired beamwidth.

Parameters:

mainLobeGain - The pencil beam main lobe gain.

beamwidth - The desired beamwidth of the pencil beam antenna, in radians.

Throws:

ArgumentException - Thrown when beamwidth is less than or equal to 0.0 or greater than π/2 radians, or mainLobeGain is less than or equal to 1.0.