agi.foundation.communications.signalpropagation

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

Class AtmosphericAttenuationModelItuRP676Version9

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalpropagation.SignalPropagationModel

agi.foundation.communications.signalpropagation.AtmosphericAttenuationModelItuRP676Version9

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class AtmosphericAttenuationModelItuRP676Version9
extends SignalPropagationModel

ITU-R P.676 version 9 Attenuation by atmospheric gases. This model is recommended for frequencies up to 1000 GHz.

To use your own atmospheric data for this model, set CustomAtmosphericModel (get / set). By default, this model will use the ITU-R P.835 atmospheric model.

Constructor Summary

Constructors

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.

Method Summary

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.

Methods inherited from class agi.foundation.communications.signalpropagation.SignalPropagationModel

checkForSameDefinition

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, 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

AtmosphericAttenuationModelItuRP676Version9

public AtmosphericAttenuationModelItuRP676Version9()

Constructs version 9 of the ITU-R P.676 model.

AtmosphericAttenuationModelItuRP676Version9

protected AtmosphericAttenuationModelItuRP676Version9(@Nonnull
                                                      AtmosphericAttenuationModelItuRP676Version9 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(SignalPropagationModel 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 SignalPropagationModel

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(AtmosphericAttenuationModelItuRP676Version9 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 AtmosphericAttenuationModelItuRP676Version9.checkForSameDefinition(agi.foundation.communications.signalpropagation.SignalPropagationModel) method.

Overrides:

computeCurrentDefinitionHashCode in class SignalPropagationModel

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling 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.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class DefinitionalObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getCentralBody

@Nonnull
public final CentralBody getCentralBody()

Gets the model's central body.

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.

getUseFastApproxMethod

public final boolean getUseFastApproxMethod()

Gets a value indicating whether to use the fast approximation method. This method is valid for frequencies greater than 1 GHz and less than 350 GHz.

setUseFastApproxMethod

public final void setUseFastApproxMethod(boolean value)

Sets a value indicating whether to use the fast approximation method. This method is valid for frequencies greater than 1 GHz and less than 350 GHz.

getUseGlobalAtmosphere

public final 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. If set to 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.

setUseGlobalAtmosphere

public final 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. If set to 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.

getCustomAtmosphericModel

public final ItuRP676AtmosphericModel getCustomAtmosphericModel()

Gets a custom atmospheric model to use when computing attenuation. By default, this property is null, and the model will use the ITU-R P.835 atmospheric model.

setCustomAtmosphericModel

public final void setCustomAtmosphericModel(ItuRP676AtmosphericModel value)

Sets a custom atmospheric model to use when computing attenuation. By default, this property is null, and the model will use the ITU-R P.835 atmospheric model.

getSignalPropagator

public SignalPropagator getSignalPropagator(EvaluatorGroup group,
                                            IServiceProvider link)

Get a propagator which can propagate a set of input signals.

Specified by:

getSignalPropagator in class SignalPropagationModel

Parameters:

group - The evaluator group in which to create the evaluator.

link - The link over which to propagate the signals.

Returns:

The evaluator producing the set of signals after propagation.

Throws:

ArgumentNullException - Thrown if the group is null.

ArgumentNullException - Thrown if the link is null.