public class ItuRF1245Version1GainPattern extends RadioFrequencyGainPattern implements IAntennaDiameterService, IAntennaEfficiencyService
Mathematical model of average and related radiation patterns for line-of-sight point-to-point radio-relay system antennas for use in certain coordination studies and interference assessment in the frequency range from 1 GHz to about 70 GHz.
Modifier | Constructor and Description |
---|---|
|
ItuRF1245Version1GainPattern()
Initializes a new instance.
|
|
ItuRF1245Version1GainPattern(double diameter,
double mainLobeGain,
double efficiency)
Create a new instance based on the given diameter, main lobe gain, and efficiency.
|
protected |
ItuRF1245Version1GainPattern(ItuRF1245Version1GainPattern existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
checkForSameDefinition(ItuRF1245Version1GainPattern 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 |
getDiameter()
Gets the antenna diameter.
|
double |
getEfficiency()
Gets the antenna efficiency, as a ratio between zero and one.
|
double |
getMainLobeGain()
Gets the main lobe gain value.
|
boolean |
getPolarizationAdvantage()
Gets a value indicating whether or not to incorporate polarization advantage.
|
void |
setDiameter(double value)
Sets the antenna diameter.
|
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 |
setPolarizationAdvantage(boolean value)
Sets a value indicating whether or not to incorporate polarization advantage.
|
checkForSameDefinition
checkForSameDefinition, getAntennaGainEvaluator, getAntennaGainEvaluator, getService
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
public ItuRF1245Version1GainPattern()
public ItuRF1245Version1GainPattern(double diameter, double mainLobeGain, double efficiency)
diameter
- The diameter of the antenna.mainLobeGain
- The main lobe gain of the antenna.efficiency
- The efficiency of the antenna.protected ItuRF1245Version1GainPattern(@Nonnull ItuRF1245Version1GainPattern existingInstance, @Nonnull CopyContext context)
See ICloneWithContext.clone(CopyContext)
for more information about how to implement this constructor
in a derived class.
existingInstance
- The existing instance to copy.context
- A CopyContext
that controls the depth of the copy.ArgumentNullException
- Thrown when existingInstance
or context
is null
.public Object clone(CopyContext 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:
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:
CopyContext.updateReference(T)
. You should still call CopyContext.updateReference(T)
on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext)
as the last line in the constructor and pass it the
same CopyContext
passed to the constructor.
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;
clone
in interface ICloneWithContext
clone
in class DefinitionalObject
context
- The context to use to perform the copy.protected final boolean checkForSameDefinition(RadioFrequencyGainPattern other)
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)
.checkForSameDefinition
in class RadioFrequencyGainPattern
other
- The other instance to compare to this one.true
if the two objects are defined equivalently; otherwise false
.protected boolean checkForSameDefinition(ItuRF1245Version1GainPattern other)
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)
.other
- The other instance to compare to this one.true
if the two objects are defined equivalently; otherwise false
.protected int computeCurrentDefinitionHashCode()
ItuRF1245Version1GainPattern.checkForSameDefinition(agi.foundation.communications.antennas.RadioFrequencyGainPattern)
method.computeCurrentDefinitionHashCode
in class RadioFrequencyGainPattern
public SignalEvaluator getApplyAntennaGainEvaluator(EvaluatorGroup group, Vector linkDirection, Axes antennaAxes, ISignalSource inputSignal, SignalPropagationGraph graph)
getApplyAntennaGainEvaluator
in interface IAntennaGainService
getApplyAntennaGainEvaluator
in class BaseGainPattern
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.ArgumentNullException
- Thrown when group
, linkDirection
, antennaAxes
,
inputSignal
, or graph
is null
.PropertyInvalidException
- Thrown if MainLobeGain
(get
/ set
) is negative, Diameter
(get
/ set
) is not greater than zero,
or if Efficiency
(get
/ set
) is not between 0 and 1.public final double getEfficiency()
Defaults to a value of 0.55.
getEfficiency
in interface IAntennaEfficiencyService
public final void setEfficiency(double value)
Defaults to a value of 0.55.
public final double getDiameter()
Defaults to a value of 1.0.
getDiameter
in interface IAntennaDiameterService
public final void setDiameter(double value)
Defaults to a value of 1.0.
public final double getMainLobeGain()
Defaults to a value of 1584.89.
public final void setMainLobeGain(double value)
Defaults to a value of 1584.89.
public final boolean getPolarizationAdvantage()
If this value is set to true, the gain will be computed using the equation outlined in Note 7 of the recommendation which takes account of polarization advantage due to main lobe-to-main lobe coupling from a circularly polarized interference source into a linearly polarized ground station.
Defaults to false.
public final void setPolarizationAdvantage(boolean value)
If this value is set to true, the gain will be computed using the equation outlined in Note 7 of the recommendation which takes account of polarization advantage due to main lobe-to-main lobe coupling from a circularly polarized interference source into a linearly polarized ground station.
Defaults to false.