public class TropoScintAttenuationModelItuRP618Version12 extends SignalPropagationModel
| Modifier | Constructor and Description |
|---|---|
|
TropoScintAttenuationModelItuRP618Version12()
Constructs version 12 of the ITU-R P.618 model.
|
protected |
TropoScintAttenuationModelItuRP618Version12(TropoScintAttenuationModelItuRP618Version12 existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
checkForSameDefinition(SignalPropagationModel other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(TropoScintAttenuationModelItuRP618Version12 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.
|
CentralBody |
getCentralBody()
Gets the model's central body.
|
boolean |
getFadeDepthAverageAnnualWorstMonth()
Gets a value indicating whether to use the fade depth for the average annual worst month.
|
double |
getFadeOutage()
Gets the fade outage percent, as a decimal.
|
double |
getMaximumAltitude()
Gets the model's maximum altitude, in meters.
|
SignalPropagator |
getSignalPropagator(EvaluatorGroup group,
IServiceProvider link)
Get a propagator which can propagate a set of input signals.
|
double |
getTimeRefractivityGradient()
Gets the percent time refractivity gradient, as a decimal.
|
void |
setFadeDepthAverageAnnualWorstMonth(boolean value)
Sets a value indicating whether to use the fade depth for the average annual worst month.
|
void |
setFadeOutage(double value)
Sets the fade outage percent, as a decimal.
|
void |
setTimeRefractivityGradient(double value)
Sets the percent time refractivity gradient, as a decimal.
|
checkForSameDefinitionareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic TropoScintAttenuationModelItuRP618Version12()
protected TropoScintAttenuationModelItuRP618Version12(@Nonnull TropoScintAttenuationModelItuRP618Version12 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(SignalPropagationModel 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 SignalPropagationModelother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(TropoScintAttenuationModelItuRP618Version12 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()
TropoScintAttenuationModelItuRP618Version12.checkForSameDefinition(agi.foundation.communications.signalpropagation.SignalPropagationModel) method.computeCurrentDefinitionHashCode in class SignalPropagationModel@Nonnull public final CentralBody getCentralBody()
This property will always return the Earth CentralBody (get) returned from the
CentralBodiesFacet.getFromContext() method and can not be overridden.
The ITU-R P.618 model is a model of the Earth's atmosphere.
public final double getMaximumAltitude()
public final boolean getFadeDepthAverageAnnualWorstMonth()
public final void setFadeDepthAverageAnnualWorstMonth(boolean value)
public final double getFadeOutage()
public final void setFadeOutage(double value)
public final double getTimeRefractivityGradient()
public final void setTimeRefractivityGradient(double value)
public SignalPropagator getSignalPropagator(EvaluatorGroup group, IServiceProvider link)
getSignalPropagator in class SignalPropagationModelgroup - The evaluator group in which to create the evaluator.link - The link over which to propagate the signals.ArgumentNullException - Thrown if the group is null.ArgumentNullException - Thrown if the link is null.PropertyInvalidException - Thrown if the FadeOutage (get / set) is less than or equal to 0.0 or greater than 1.0.PropertyInvalidException - Thrown if the TimeRefractivityGradient (get / set) is less than or equal to 0.0 or greater than 1.0.