public class AtmosphericAttenuationModelItuRP676Version9 extends SignalPropagationModel
Modifier | Constructor and Description |
---|---|
|
AtmosphericAttenuationModelItuRP676Version9()
Constructs version 9 of the ITU-R P.676 model.
|
protected |
AtmosphericAttenuationModelItuRP676Version9(AtmosphericAttenuationModelItuRP676Version9 existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
checkForSameDefinition(AtmosphericAttenuationModelItuRP676Version9 other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(SignalPropagationModel 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 |
enumerateDependencies(DependencyEnumerator enumerator)
Enumerates the dependencies of this object by calling
DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. |
CentralBody |
getCentralBody()
Gets the model's central body.
|
ItuRP676AtmosphericModel |
getCustomAtmosphericModel()
Gets a custom atmospheric model to use when computing attenuation.
|
SignalPropagator |
getSignalPropagator(EvaluatorGroup group,
IServiceProvider link)
Get a propagator which can propagate a set of input signals.
|
boolean |
getUseFastApproxMethod()
Gets a value indicating whether to use the fast approximation method.
|
boolean |
getUseGlobalAtmosphere()
Gets a value indicating whether to use the ITU-R P.835 global atmospheric model for
determining the pressure, water vapor pressure, and temperature at a specific altitude.
|
void |
setCustomAtmosphericModel(ItuRP676AtmosphericModel value)
Sets a custom atmospheric model to use when computing attenuation.
|
void |
setUseFastApproxMethod(boolean value)
Sets a value indicating whether to use the fast approximation method.
|
void |
setUseGlobalAtmosphere(boolean value)
Sets a value indicating whether to use the ITU-R P.835 global atmospheric model for
determining the pressure, water vapor pressure, and temperature at a specific altitude.
|
checkForSameDefinition
areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen
public AtmosphericAttenuationModelItuRP676Version9()
protected AtmosphericAttenuationModelItuRP676Version9(@Nonnull AtmosphericAttenuationModelItuRP676Version9 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(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 SignalPropagationModel
other
- The other instance to compare to this one.true
if the two objects are defined equivalently; otherwise false
.protected boolean checkForSameDefinition(AtmosphericAttenuationModelItuRP676Version9 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()
AtmosphericAttenuationModelItuRP676Version9.checkForSameDefinition(agi.foundation.communications.signalpropagation.SignalPropagationModel)
method.computeCurrentDefinitionHashCode
in class SignalPropagationModel
public void enumerateDependencies(DependencyEnumerator enumerator)
DependencyEnumerator#enumerate(T)
for each object that this object directly depends upon.
Derived classes which contain additional dependencies MUST override this method, call the base
implementation, and enumerate dependencies introduced by the derived class.enumerateDependencies
in interface IEnumerateDependencies
enumerateDependencies
in class DefinitionalObject
enumerator
- The enumerator that is informed of the dependencies of this object.@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.676 model is a model of the Earth's atmosphere.
public final boolean getUseFastApproxMethod()
public final void setUseFastApproxMethod(boolean value)
public final boolean getUseGlobalAtmosphere()
false
, the ITU-R P.835 seasonal/regional model is used to
determine the pressure, water vapor pressure, and temperature of the atmosphere.
This setting is ignored if CustomAtmosphericModel
(get
/ set
) is used.public final void setUseGlobalAtmosphere(boolean value)
false
, the ITU-R P.835 seasonal/regional model is used to
determine the pressure, water vapor pressure, and temperature of the atmosphere.
This setting is ignored if CustomAtmosphericModel
(get
/ set
) is used.public final ItuRP676AtmosphericModel getCustomAtmosphericModel()
null
, and the model will
use the ITU-R P.835 atmospheric model.public final void setCustomAtmosphericModel(ItuRP676AtmosphericModel value)
null
, and the model will
use the ITU-R P.835 atmospheric model.public SignalPropagator getSignalPropagator(EvaluatorGroup group, IServiceProvider link)
getSignalPropagator
in class SignalPropagationModel
group
- 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.