public class PencilBeamGainPattern extends RadioFrequencyGainPattern
| 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.
|
| 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.
|
checkForSameDefinitioncheckForSameDefinition, getAntennaGainEvaluator, getAntennaGainEvaluator, getServiceareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic PencilBeamGainPattern()
public PencilBeamGainPattern(double mainLobeGain,
double beamwidth)
mainLobeGain - The pencil beam main lobe gain.beamwidth - The desired beamwidth of the pencil beam antenna, in radians.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.protected PencilBeamGainPattern(@Nonnull PencilBeamGainPattern 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 ICloneWithContextclone in class DefinitionalObjectcontext - 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 RadioFrequencyGainPatternother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(PencilBeamGainPattern 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()
PencilBeamGainPattern.checkForSameDefinition(agi.foundation.communications.antennas.RadioFrequencyGainPattern) method.computeCurrentDefinitionHashCode in class RadioFrequencyGainPatternpublic SignalEvaluator getApplyAntennaGainEvaluator(EvaluatorGroup group, Vector linkDirection, Axes antennaAxes, ISignalSource inputSignal, SignalPropagationGraph graph)
getApplyAntennaGainEvaluator in interface IAntennaGainServicegetApplyAntennaGainEvaluator in class BaseGainPatterngroup - 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.inputSignal without applying a gain.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.public final double getMainLobeGain()
Defaults to a value of 10000.0.
public final void setMainLobeGain(double value)
Defaults to a value of 10000.0.
public final double getSideLobeGain()
Defaults to a value of 0.5.
public final void setSideLobeGain(double value)
Defaults to a value of 0.5.
public final void configureMainLobeGainAndBeamwidth(double mainLobeGain,
double beamwidth)
mainLobeGain - The pencil beam main lobe gain.beamwidth - The desired beamwidth of the pencil beam antenna, in radians.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.