agi.foundation.communications.signalpropagation

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

Class IonosphericAttenuationModelItuRP531Version13

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalpropagation.SignalPropagationModel

agi.foundation.communications.signalpropagation.IonosphericAttenuationModelItuRP531Version13

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class IonosphericAttenuationModelItuRP531Version13
extends SignalPropagationModel

ITU-R P.531 version 13 ionospheric attenuation model. This model is recommended for frequencies of 0.1 GHz to 12 GHz.

Constructor Summary

Constructors

Modifier	Constructor and Description
	IonosphericAttenuationModelItuRP531Version13() Constructs version 13 of the ITU-R P.531 model.
protected	IonosphericAttenuationModelItuRP531Version13(IonosphericAttenuationModelItuRP531Version13 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(IonosphericAttenuationModelItuRP531Version13 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.
MagneticFieldVector	getMagneticField() Gets or sets a vector used to compute the magnetic flux density at a point.
ScalarDependentOnServiceProvider	getMagneticFieldStrength() Gets or sets the magnetic field strength, in tesla.
double	getMaximumAltitude() Gets the maximum altitude of the model.
double	getMaximumFrequency() Gets the maximum frequency below which the model takes effect.
double	getMinimumAltitude() Gets the minimum altitude of the model.
double	getMinimumFrequency() Gets the minimum frequency above which the model takes effect.
SignalPropagator	getSignalPropagator(EvaluatorGroup group, IServiceProvider link) Get a propagator which can propagate a set of input signals.
ScalarDependentOnServiceProvider	getTotalElectronContent() Gets or sets the total electron content, in electrons per square meter.
void	setMagneticField(MagneticFieldVector value) Gets or sets a vector used to compute the magnetic flux density at a point.
void	setMagneticFieldStrength(ScalarDependentOnServiceProvider value) Gets or sets the magnetic field strength, in tesla.
void	setMaximumAltitude(double value) Sets the maximum altitude of the model.
void	setMaximumFrequency(double value) Sets the maximum frequency below which the model takes effect.
void	setMinimumAltitude(double value) Sets the minimum altitude of the model.
void	setMinimumFrequency(double value) Sets the minimum frequency above which the model takes effect.
void	setTotalElectronContent(ScalarDependentOnServiceProvider value) Gets or sets the total electron content, in electrons per square meter.

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

IonosphericAttenuationModelItuRP531Version13

public IonosphericAttenuationModelItuRP531Version13()

Constructs version 13 of the ITU-R P.531 model.

IonosphericAttenuationModelItuRP531Version13

protected IonosphericAttenuationModelItuRP531Version13(@Nonnull
                                                       IonosphericAttenuationModelItuRP531Version13 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(IonosphericAttenuationModelItuRP531Version13 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 IonosphericAttenuationModelItuRP531Version13.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.531 model is a model of the Earth's ionosphere.

getMinimumFrequency

public final double getMinimumFrequency()

Gets the minimum frequency above which the model takes effect. By default, this is 0.1e9 Hertz.

setMinimumFrequency

public final void setMinimumFrequency(double value)

Sets the minimum frequency above which the model takes effect. By default, this is 0.1e9 Hertz.

getMaximumFrequency

public final double getMaximumFrequency()

Gets the maximum frequency below which the model takes effect. By default, this is 12.0e9 Hertz.

setMaximumFrequency

public final void setMaximumFrequency(double value)

Sets the maximum frequency below which the model takes effect. By default, this is 12.0e9 Hertz.

getMinimumAltitude

public final double getMinimumAltitude()

Gets the minimum altitude of the model. By default, this is 80000.0 meters.

setMinimumAltitude

public final void setMinimumAltitude(double value)

Sets the minimum altitude of the model. By default, this is 80000.0 meters.

getMaximumAltitude

public final double getMaximumAltitude()

Gets the maximum altitude of the model. By default, this is 2500000.0 meters.

setMaximumAltitude

public final void setMaximumAltitude(double value)

Sets the maximum altitude of the model. By default, this is 2500000.0 meters.

getMagneticField

public final MagneticFieldVector getMagneticField()

Gets or sets a vector used to compute the magnetic flux density at a point.

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

Throws:

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

setMagneticField

public final void setMagneticField(MagneticFieldVector value)

Gets or sets a vector used to compute the magnetic flux density at a point.

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

Throws:

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

getMagneticFieldStrength

public final ScalarDependentOnServiceProvider getMagneticFieldStrength()

Gets or sets the magnetic field strength, in tesla. This scalar will be provided with a service provider providing ILinkService.

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

Throws:

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

setMagneticFieldStrength

public final void setMagneticFieldStrength(ScalarDependentOnServiceProvider value)

Gets or sets the magnetic field strength, in tesla. This scalar will be provided with a service provider providing ILinkService.

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

Throws:

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

getTotalElectronContent

public final ScalarDependentOnServiceProvider getTotalElectronContent()

Gets or sets the total electron content, in electrons per square meter. This scalar will be provided with a service provider providing ILinkService.

setTotalElectronContent

public final void setTotalElectronContent(ScalarDependentOnServiceProvider value)

Gets or sets the total electron content, in electrons per square meter. This scalar will be provided with a service provider providing ILinkService.

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 electron concentration is negative.