agi.foundation.communications.signalpropagation

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

Class RainAttenuationModelItuRP618Version12

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalpropagation.SignalPropagationModel

agi.foundation.communications.signalpropagation.RainAttenuationModelItuRP618Version12

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class RainAttenuationModelItuRP618Version12
extends SignalPropagationModel

ITU-R P.618 version 12 rain attenuation model. This model is recommended for frequencies up to 55 GHz.

Constructor Summary

Constructors

Modifier	Constructor and Description
	RainAttenuationModelItuRP618Version12() Constructs version 12 of the ITU-R P.618 model.
protected	RainAttenuationModelItuRP618Version12(RainAttenuationModelItuRP618Version12 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(RainAttenuationModelItuRP618Version12 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	getCustomRainHeight() Gets a custom value for the rain height, in meters.
ScalarDependentOnServiceProvider	getCustomRainRate() Gets a custom value for the rain rate exceeded 0.01% of the time, in meters per second.
boolean	getEnableCrossPolarizationEffects() Gets a value indicating whether to enable cross polarization effects.
double	getMaximumAltitude() Gets the model's maximum altitude, in meters.
double	getOutagePercent() Gets the rain outage percent value, as a decimal.
SignalPropagator	getSignalPropagator(EvaluatorGroup group, IServiceProvider link) Get a propagator which can propagate a set of input signals.
void	setCustomRainHeight(ScalarDependentOnServiceProvider value) Sets a custom value for the rain height, in meters.
void	setCustomRainRate(ScalarDependentOnServiceProvider value) Sets a custom value for the rain rate exceeded 0.01% of the time, in meters per second.
void	setEnableCrossPolarizationEffects(boolean value) Sets a value indicating whether to enable cross polarization effects.
void	setOutagePercent(double value) Sets the rain outage percent value, as a decimal.

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

RainAttenuationModelItuRP618Version12

public RainAttenuationModelItuRP618Version12()

Constructs version 12 of the ITU-R P.618 model.

RainAttenuationModelItuRP618Version12

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

getMaximumAltitude

public final double getMaximumAltitude()

Gets the model's maximum altitude, in meters.

getOutagePercent

public final double getOutagePercent()

Gets the rain outage percent value, as a decimal.

The valid range is between 0% and 5%.

setOutagePercent

public final void setOutagePercent(double value)

Sets the rain outage percent value, as a decimal.

The valid range is between 0% and 5%.

getEnableCrossPolarizationEffects

public final boolean getEnableCrossPolarizationEffects()

Gets a value indicating whether to enable cross polarization effects.

setEnableCrossPolarizationEffects

public final void setEnableCrossPolarizationEffects(boolean value)

Sets a value indicating whether to enable cross polarization effects.

getCustomRainHeight

public final ScalarDependentOnServiceProvider getCustomRainHeight()

Gets a custom value for the rain height, in meters. By default, this property is null, and the rain height will be determined by ITU-R P.839 rain height data. This scalar will be provided with a service provider providing ILinkService.

setCustomRainHeight

public final void setCustomRainHeight(ScalarDependentOnServiceProvider value)

Sets a custom value for the rain height, in meters. By default, this property is null, and the rain height will be determined by ITU-R P.839 rain height data. This scalar will be provided with a service provider providing ILinkService.

getCustomRainRate

public final ScalarDependentOnServiceProvider getCustomRainRate()

Gets a custom value for the rain rate exceeded 0.01% of the time, in meters per second. By default, this property is null, and the rain rate will be determined by the model. This scalar will be provided with a service provider providing ILinkService.

The valid range is between 0 and 0.00006944 meters per second.

setCustomRainRate

public final void setCustomRainRate(ScalarDependentOnServiceProvider value)

Sets a custom value for the rain rate exceeded 0.01% of the time, in meters per second. By default, this property is null, and the rain rate will be determined by the model. This scalar will be provided with a service provider providing ILinkService.

The valid range is between 0 and 0.00006944 meters per second.

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.

PropertyInvalidException - Thrown if OutagePercent (get / set) is less than zero or greater than 5.

PropertyInvalidException - Thrown if the rain height evaluated using the CustomRainHeight (get / set) scalar is negative or greater than the MaximumAltitude (get).

PropertyInvalidException - Thrown if the rain rate evaluated using the CustomRainRate (get / set) scalar is negative or greater than 0.00006944 meters per second.