agi.foundation.communications.signalpropagation

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

Class CloudFogAttenuationModelItuRP840Version6

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalpropagation.SignalPropagationModel

agi.foundation.communications.signalpropagation.CloudFogAttenuationModelItuRP840Version6

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class CloudFogAttenuationModelItuRP840Version6
extends SignalPropagationModel

ITU-R P.840 version 6 cloud and fog attenuation model. This model is recommended for frequencies up to 1000 GHz.

The atmospheric conditions can be configured in two different ways. When using CloudCeiling (get / set) and CloudLayerThickness (get / set), the link is divided into sub-segments based on how the link intersects the resulting single cloud layer, with attenuation only occurring within that layer, where CloudTemperature (get / set) and CloudLiquidWaterDensity (get / set) define the conditions inside the cloud layer. This geometric arrangement is simple to configure, but is best suited to geometries where the link is primarily vertical.

Alternatively, configure CustomLinkSubdivision (get / set), which determines how the link should be subdivided, and CustomAtmosphericModel (get / set), which determines the atmospheric conditions at the midpoint of each sub-segment. Sub-segments can be regularly or irregularly spaced. The atmospheric values are assumed constant over each sub-segment. This configuration is more complex, but can represent geometries where the link is primarily horizontal and the signal might pass through multiple distinct weather cells.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CloudFogAttenuationModelItuRP840Version6() Constructs version 6 of the ITU-R P.840 model.
protected	CloudFogAttenuationModelItuRP840Version6(CloudFogAttenuationModelItuRP840Version6 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(CloudFogAttenuationModelItuRP840Version6 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.
ScalarDependentOnServiceProvider	getCloudCeiling() Gets or sets a value for the cloud ceiling, in meters.
ScalarDependentOnServiceProvider	getCloudLayerThickness() Gets or sets a value for the cloud layer thickness, in meters.
ScalarDependentOnServiceProvider	getCloudLiquidWaterDensity() Gets or sets the cloud liquid water density, in g/m3.
ScalarDependentOnServiceProvider	getCloudTemperature() Gets or sets the cloud temperature, in kelvin.
ItuRP840AtmosphericModel	getCustomAtmosphericModel() Gets or sets a custom atmospheric model to use when computing attenuation.
LinkSubdivision	getCustomLinkSubdivision() Gets or sets a custom object which will be used to subdivide the link into sub-segments, which will then define the sample locations where the CustomAtmosphericModel (get / set) will be asked to obtain atmospheric data.
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.
void	setCloudCeiling(ScalarDependentOnServiceProvider value) Gets or sets a value for the cloud ceiling, in meters.
void	setCloudLayerThickness(ScalarDependentOnServiceProvider value) Gets or sets a value for the cloud layer thickness, in meters.
void	setCloudLiquidWaterDensity(ScalarDependentOnServiceProvider value) Gets or sets the cloud liquid water density, in g/m3.
void	setCloudTemperature(ScalarDependentOnServiceProvider value) Gets or sets the cloud temperature, in kelvin.
void	setCustomAtmosphericModel(ItuRP840AtmosphericModel value) Gets or sets a custom atmospheric model to use when computing attenuation.
void	setCustomLinkSubdivision(LinkSubdivision value) Gets or sets a custom object which will be used to subdivide the link into sub-segments, which will then define the sample locations where the CustomAtmosphericModel (get / set) will be asked to obtain atmospheric data.

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

CloudFogAttenuationModelItuRP840Version6

public CloudFogAttenuationModelItuRP840Version6()

Constructs version 6 of the ITU-R P.840 model. The default configuration uses the following default values:

Property	Default Value
CloudCeiling (get / set)	3000 m
CloudLayerThickness (get / set)	500 m
CloudTemperature (get / set)	273.15 K
CloudLiquidWaterDensity (get / set)	7.5 g/m3

CloudFogAttenuationModelItuRP840Version6

protected CloudFogAttenuationModelItuRP840Version6(@Nonnull
                                                   CloudFogAttenuationModelItuRP840Version6 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(CloudFogAttenuationModelItuRP840Version6 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 CloudFogAttenuationModelItuRP840Version6.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.840 model is a model of the Earth's atmosphere.

getMaximumAltitude

public final double getMaximumAltitude()

Gets the model's maximum altitude, in meters.

getCustomLinkSubdivision

public final LinkSubdivision getCustomLinkSubdivision()

Gets or sets a custom object which will be used to subdivide the link into sub-segments, which will then define the sample locations where the CustomAtmosphericModel (get / set) will be asked to obtain atmospheric data. Atmospheric conditions are assumed constant over each sub-segment.

Note that this property is mutually exclusive with CloudCeiling (get / set) and CloudLayerThickness (get / set) and configuring this property will replace any configured CloudCeiling (get / set) and CloudLayerThickness (get / set).

setCustomLinkSubdivision

public final void setCustomLinkSubdivision(LinkSubdivision value)

Gets or sets a custom object which will be used to subdivide the link into sub-segments, which will then define the sample locations where the CustomAtmosphericModel (get / set) will be asked to obtain atmospheric data. Atmospheric conditions are assumed constant over each sub-segment.

Note that this property is mutually exclusive with CloudCeiling (get / set) and CloudLayerThickness (get / set) and configuring this property will replace any configured CloudCeiling (get / set) and CloudLayerThickness (get / set).

getCloudCeiling

public final ScalarDependentOnServiceProvider getCloudCeiling()

Gets or sets a value for the cloud ceiling, in meters. This scalar will be provided with a service provider providing ILinkService.

Note that this property is mutually exclusive with CustomLinkSubdivision (get / set), and this property cannot be used if a CustomLinkSubdivision (get / set) is configured.

The cloud ceiling defines the bottom of the cloud layer with respect to an entity on the surface of the earth. Not to be confused with the top of the cloud layer, which would be the ceiling of the layer if the entity was located in the layer.

During evaluation, a PropertyInvalidException is thrown if the cloud ceiling is less than zero or greater than MaximumAltitude (get).

Throws:

IllegalStateException - Thrown when a CustomLinkSubdivision (get / set) has been configured.

setCloudCeiling

public final void setCloudCeiling(ScalarDependentOnServiceProvider value)

Gets or sets a value for the cloud ceiling, in meters. This scalar will be provided with a service provider providing ILinkService.

Note that this property is mutually exclusive with CustomLinkSubdivision (get / set), and this property cannot be used if a CustomLinkSubdivision (get / set) is configured.

The cloud ceiling defines the bottom of the cloud layer with respect to an entity on the surface of the earth. Not to be confused with the top of the cloud layer, which would be the ceiling of the layer if the entity was located in the layer.

During evaluation, a PropertyInvalidException is thrown if the cloud ceiling is less than zero or greater than MaximumAltitude (get).

Throws:

IllegalStateException - Thrown when a CustomLinkSubdivision (get / set) has been configured.

getCloudLayerThickness

public final ScalarDependentOnServiceProvider getCloudLayerThickness()

Gets or sets a value for the cloud layer thickness, in meters. This scalar will be provided with a service provider providing ILinkService.

Note that this property is mutually exclusive with CustomLinkSubdivision (get / set), and this property cannot be used if a CustomLinkSubdivision (get / set) is configured.

The cloud ceiling plus the cloud layer thickness would give the cloud layer top.

During evaluation, a PropertyInvalidException is thrown if the cloud layer thickness is less than zero or greater than MaximumAltitude (get).

Throws:

IllegalStateException - Thrown when a CustomLinkSubdivision (get / set) has been configured.

setCloudLayerThickness

public final void setCloudLayerThickness(ScalarDependentOnServiceProvider value)

Gets or sets a value for the cloud layer thickness, in meters. This scalar will be provided with a service provider providing ILinkService.

Note that this property is mutually exclusive with CustomLinkSubdivision (get / set), and this property cannot be used if a CustomLinkSubdivision (get / set) is configured.

The cloud ceiling plus the cloud layer thickness would give the cloud layer top.

During evaluation, a PropertyInvalidException is thrown if the cloud layer thickness is less than zero or greater than MaximumAltitude (get).

Throws:

IllegalStateException - Thrown when a CustomLinkSubdivision (get / set) has been configured.

getCustomAtmosphericModel

public final ItuRP840AtmosphericModel getCustomAtmosphericModel()

Gets or sets a custom atmospheric model to use when computing attenuation.

Note that this property is mutually exclusive with CloudTemperature (get / set) and CloudLiquidWaterDensity (get / set) and configuring this property will replace any configured CloudTemperature (get / set) and CloudLiquidWaterDensity (get / set).

During evaluation, a PropertyInvalidException is thrown if the cloud temperature is less than 173.15 or greater than 373.15 K, or if the cloud liquid water density is less than zero or greater than 100 g/m³.

setCustomAtmosphericModel

public final void setCustomAtmosphericModel(ItuRP840AtmosphericModel value)

Gets or sets a custom atmospheric model to use when computing attenuation.

Note that this property is mutually exclusive with CloudTemperature (get / set) and CloudLiquidWaterDensity (get / set) and configuring this property will replace any configured CloudTemperature (get / set) and CloudLiquidWaterDensity (get / set).

During evaluation, a PropertyInvalidException is thrown if the cloud temperature is less than 173.15 or greater than 373.15 K, or if the cloud liquid water density is less than zero or greater than 100 g/m³.

getCloudTemperature

public final ScalarDependentOnServiceProvider getCloudTemperature()

Gets or sets the cloud temperature, in kelvin. This scalar will be provided with a service provider providing ILinkService.

Note that this property is mutually exclusive with CustomAtmosphericModel (get / set), and this property cannot be used if a CustomAtmosphericModel (get / set) is configured.

During evaluation, a PropertyInvalidException is thrown if the cloud temperature is less than 173.15 or greater than 373.15 K.

Throws:

IllegalStateException - Thrown when a CustomAtmosphericModel (get / set) has been configured.

setCloudTemperature

public final void setCloudTemperature(ScalarDependentOnServiceProvider value)

Gets or sets the cloud temperature, in kelvin. This scalar will be provided with a service provider providing ILinkService.

Note that this property is mutually exclusive with CustomAtmosphericModel (get / set), and this property cannot be used if a CustomAtmosphericModel (get / set) is configured.

During evaluation, a PropertyInvalidException is thrown if the cloud temperature is less than 173.15 or greater than 373.15 K.

Throws:

IllegalStateException - Thrown when a CustomAtmosphericModel (get / set) has been configured.

getCloudLiquidWaterDensity

public final ScalarDependentOnServiceProvider getCloudLiquidWaterDensity()

Gets or sets the cloud liquid water density, in g/m³. This scalar will be provided with a service provider providing ILinkService.

Note that this property is mutually exclusive with CustomAtmosphericModel (get / set), and this property cannot be used if a CustomAtmosphericModel (get / set) is configured.

During evaluation, a PropertyInvalidException is thrown if the cloud liquid water density is less than zero or greater than 100 g/m³.

Throws:

IllegalStateException - Thrown when a CustomAtmosphericModel (get / set) has been configured.

setCloudLiquidWaterDensity

public final void setCloudLiquidWaterDensity(ScalarDependentOnServiceProvider value)

Gets or sets the cloud liquid water density, in g/m³. This scalar will be provided with a service provider providing ILinkService.

Note that this property is mutually exclusive with CustomAtmosphericModel (get / set), and this property cannot be used if a CustomAtmosphericModel (get / set) is configured.

During evaluation, a PropertyInvalidException is thrown if the cloud liquid water density is less than zero or greater than 100 g/m³.

Throws:

IllegalStateException - Thrown when a CustomAtmosphericModel (get / set) has been configured.

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 when group or link is null.

PropertyInvalidException - Thrown during propagation when the cloud ceiling is negative or above the MaximumAltitude (get), or the cloud thickness is negative or above the MaximumAltitude (get), or the cloud temperature is below 173.15 K or above 373.15 K, or the cloud liquid water density is below 0 or above 100 g/m³.