agi.foundation.communications.antennas

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

Class CosineSquaredPedestalRectangularApertureGainPattern

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.antennas.BaseGainPattern

agi.foundation.communications.antennas.RadioFrequencyGainPattern

agi.foundation.communications.antennas.CosineSquaredPedestalRectangularApertureGainPattern

All Implemented Interfaces:

IAntennaEfficiencyService, IAntennaGainService, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IServiceProvider

public class CosineSquaredPedestalRectangularApertureGainPattern
extends RadioFrequencyGainPattern
implements IAntennaEfficiencyService

A cosine squared pedestal rectangular aperture antenna gain pattern.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CosineSquaredPedestalRectangularApertureGainPattern() Initializes a new instance.
protected	CosineSquaredPedestalRectangularApertureGainPattern(CosineSquaredPedestalRectangularApertureGainPattern existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	CosineSquaredPedestalRectangularApertureGainPattern(double pedestalLevel, double xDimension, double yDimension, double efficiency, double backLobeGain) Create a new instance based on the given pedestal level, x and y dimensions, efficiency, and back lobe gain.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(CosineSquaredPedestalRectangularApertureGainPattern 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.
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	getBackLobeGain() Gets the antenna back lobe gain, applied when the angle is greater than 90 degrees from the boresight.
double	getEfficiency() Gets the antenna efficiency, as a ratio between zero and one.
double	getMainLobeGain() Gets the main lobe gain value.
boolean	getMainLobeGainOverride() Gets a value indicating whether the main lobe gain value should be used instead of the value computed by the model.
double	getPedestalLevel() Gets the pedestal level.
double	getXDimension() Gets the antenna x dimension.
double	getYDimension() Gets the antenna y dimension.
void	setBackLobeGain(double value) Sets the antenna back lobe gain, applied when the angle is greater than 90 degrees from the boresight.
void	setEfficiency(double value) Sets the antenna efficiency, as a ratio between zero and one.
void	setMainLobeGain(double value) Sets the main lobe gain value.
void	setMainLobeGainOverride(boolean value) Sets a value indicating whether the main lobe gain value should be used instead of the value computed by the model.
void	setPedestalLevel(double value) Sets the pedestal level.
void	setXDimension(double value) Sets the antenna x dimension.
void	setYDimension(double value) Sets the antenna y dimension.

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

CosineSquaredPedestalRectangularApertureGainPattern

public CosineSquaredPedestalRectangularApertureGainPattern()

Initializes a new instance.

Table of property default values.

Property	Default Value
Efficiency (get / set)	0.55
XDimension (get / set)	1.0
YDimension (get / set)	1.0
PedestalLevel (get / set)	1.0e-10
BackLobeGain (get / set)	0.001
MainLobeGain (get / set)	1.0
MainLobeGainOverride (get / set)	false

CosineSquaredPedestalRectangularApertureGainPattern

public CosineSquaredPedestalRectangularApertureGainPattern(double pedestalLevel,
                                                           double xDimension,
                                                           double yDimension,
                                                           double efficiency,
                                                           double backLobeGain)

Create a new instance based on the given pedestal level, x and y dimensions, efficiency, and back lobe gain.

Parameters:

pedestalLevel - The pedestal level.

xDimension - The x dimension of the antenna.

yDimension - The y dimension of the antenna.

efficiency - The efficiency of the antenna.

backLobeGain - The back lobe gain of the antenna, applied when the angle is greater than 90 degrees from the boresight.

CosineSquaredPedestalRectangularApertureGainPattern

protected CosineSquaredPedestalRectangularApertureGainPattern(@Nonnull
                                                              CosineSquaredPedestalRectangularApertureGainPattern 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(CosineSquaredPedestalRectangularApertureGainPattern 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 CosineSquaredPedestalRectangularApertureGainPattern.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 source of the input signal to modify.

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

Returns:

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

Throws:

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

PropertyInvalidException - Thrown if BackLobeGain (get / set) is negative, MainLobeGain (get / set) is negative, XDimension (get / set) is not greater than zero, YDimension (get / set) is not greater than zero, PedestalLevel (get / set) is less than or equal to 0.0 or greater than 1.0, or if Efficiency (get / set) is not between 0 and 1.

getEfficiency

public final double getEfficiency()

Gets the antenna efficiency, as a ratio between zero and one.

Defaults to a value of 0.55.

Specified by:

getEfficiency in interface IAntennaEfficiencyService

setEfficiency

public final void setEfficiency(double value)

Sets the antenna efficiency, as a ratio between zero and one.

Defaults to a value of 0.55.

getXDimension

public final double getXDimension()

Gets the antenna x dimension.

Defaults to a value of 1.0.

setXDimension

public final void setXDimension(double value)

Sets the antenna x dimension.

Defaults to a value of 1.0.

getYDimension

public final double getYDimension()

Gets the antenna y dimension.

Defaults to a value of 1.0.

setYDimension

public final void setYDimension(double value)

Sets the antenna y dimension.

Defaults to a value of 1.0.

getPedestalLevel

public final double getPedestalLevel()

Gets the pedestal level. The pedestal level must be greater than 0.0 and less than or equal to 1.0.

Defaults to a value of 1.0e-10.

setPedestalLevel

public final void setPedestalLevel(double value)

Sets the pedestal level. The pedestal level must be greater than 0.0 and less than or equal to 1.0.

Defaults to a value of 1.0e-10.

getBackLobeGain

public final double getBackLobeGain()

Gets the antenna back lobe gain, applied when the angle is greater than 90 degrees from the boresight.

Defaults to a value of 0.001.

setBackLobeGain

public final void setBackLobeGain(double value)

Sets the antenna back lobe gain, applied when the angle is greater than 90 degrees from the boresight.

Defaults to a value of 0.001.

getMainLobeGain

public final double getMainLobeGain()

Gets the main lobe gain value.

Defaults to a value of 1.0.

setMainLobeGain

public final void setMainLobeGain(double value)

Sets the main lobe gain value.

Defaults to a value of 1.0.

getMainLobeGainOverride

public final boolean getMainLobeGainOverride()

Gets a value indicating whether the main lobe gain value should be used instead of the value computed by the model. If set to true, the value returned from the MainLobeGain (get / set) property will be used as the main lobe gain. If set to false, the model will compute the main lobe gain value.

Defaults to false.

setMainLobeGainOverride

public final void setMainLobeGainOverride(boolean value)

Sets a value indicating whether the main lobe gain value should be used instead of the value computed by the model. If set to true, the value returned from the MainLobeGain (get / set) property will be used as the main lobe gain. If set to false, the model will compute the main lobe gain value.

Defaults to false.