agi.foundation.communications.signalpropagation

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

Class SignalPropagationModel

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalpropagation.SignalPropagationModel

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

AtmosphericAttenuationModelItuRP676Version9, BeerLambertLawAtmosphericAttenuationModel, CloudFogAttenuationModelItuRP840Version6, CraneRainAttenuationModel, DopplerShiftModel, FreeSpacePathLossModel, RainAttenuationModelItuRP618Version10, RainAttenuationModelItuRP618Version12, RainAttenuationModelItuRP838Version3, SimpleSatcomAtmosphericAttenuationModel, TiremPropagationModel, TiremPropagationModel3_18, TropoScintAttenuationModelItuRP1814, TropoScintAttenuationModelItuRP618Version12, TropoScintAttenuationModelItuRP618Version9

public abstract class SignalPropagationModel
extends DefinitionalObject

Base class for a signal propagation model which takes a set of signals and modifies them based on propagation effects.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SignalPropagationModel() Initializes a new instance.
protected	SignalPropagationModel(SignalPropagationModel 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(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(SignalPropagationModel other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
abstract SignalPropagator	getSignalPropagator(EvaluatorGroup group, IServiceProvider link) Get a propagator which can propagate a signal along the given communication link.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

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

SignalPropagationModel

protected SignalPropagationModel()

Initializes a new instance.

SignalPropagationModel

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

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObject 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 DefinitionalObject

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected abstract 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).

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 SignalPropagationModel.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getSignalPropagator

@Nonnull
public abstract SignalPropagator getSignalPropagator(@Nonnull
                                                               EvaluatorGroup group,
                                                               @Nonnull
                                                               IServiceProvider link)

Get a propagator which can propagate a signal along the given communication link.

Parameters:

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

link - The link over which to propagate the signals. This service provider must provide the ILinkService service.

Returns:

The propagator which can propagate a signal along the given link.