public class BeerLambertLawAtmosphericAttenuationModel extends SignalPropagationModel
The receive power is modeled using the equation Pr = Pt * exp(-alpha * L) where Pt is the transmit power, alpha is the wavelength dependent extinction coefficient, and L is the path length. The model computes up to a user selectable maximum altitude. If either the transmitter or receiver is above the maximum altitude, the path length is computed from the point where the line of sight vector, between the transmitter and receiver objects, intersects the maximum altitude to the object (transmitter or receiver) which resides below the maximum altitude. If both transmitter and receiver reside below the maximum altitude, the path length is the line of sight distance between the transmitter and receiver.
This is the Beer-Lambert Law atmospheric absorption model taken from chapter 3 page 107 of "Optical Wireless Communications - System and Channel Modeling with MATLAB" by Z. Ghassemlooy, W. Popoola, and S. Rajbhandari.
| Modifier | Constructor and Description |
|---|---|
|
BeerLambertLawAtmosphericAttenuationModel()
Initializes a new instance.
|
protected |
BeerLambertLawAtmosphericAttenuationModel(BeerLambertLawAtmosphericAttenuationModel existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
BeerLambertLawAtmosphericAttenuationModel(SignalComputation extinctionCoefficientModel,
double maximumAltitude,
CentralBody centralBody)
Initializes a new instance with given extinction coefficient model, maximum altitude, and central body.
|
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
checkForSameDefinition(BeerLambertLawAtmosphericAttenuationModel 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 central body.
|
SignalComputation |
getExtinctionCoefficientModel()
Gets the model for calculating the extinction coefficient.
|
double |
getMaximumAltitude()
Gets the maximum altitude in meters.
|
SignalPropagator |
getSignalPropagator(EvaluatorGroup group,
IServiceProvider link)
Get a propagator which can propagate a signal along the given communication link.
|
void |
setCentralBody(CentralBody value)
Sets the central body.
|
void |
setExtinctionCoefficientModel(SignalComputation value)
Sets the model for calculating the extinction coefficient.
|
void |
setMaximumAltitude(double value)
Sets the maximum altitude in meters.
|
checkForSameDefinitionareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic BeerLambertLawAtmosphericAttenuationModel()
By default, the model uses the Earth central body, a constant extinction coefficient of 1.3e-4 m-1, and a maximum altitude of 22860.0 meters.
public BeerLambertLawAtmosphericAttenuationModel(SignalComputation extinctionCoefficientModel, double maximumAltitude, CentralBody centralBody)
extinctionCoefficientModel - The model for computing the extinction coefficient.maximumAltitude - The maximum altitude limit of the propagation model.centralBody - The central body used as the altitude reference.protected BeerLambertLawAtmosphericAttenuationModel(@Nonnull BeerLambertLawAtmosphericAttenuationModel existingInstance, @Nonnull CopyContext context)
See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor
in a derived class.
existingInstance - The existing instance to copy.context - A CopyContext that controls the depth of the copy.ArgumentNullException - Thrown when existingInstance or context is null.public Object clone(CopyContext 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:
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:
CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the
same CopyContext passed to the constructor.
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;clone in interface ICloneWithContextclone in class DefinitionalObjectcontext - The context to use to perform the copy.protected final boolean checkForSameDefinition(SignalPropagationModel other)
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).checkForSameDefinition in class SignalPropagationModelother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(BeerLambertLawAtmosphericAttenuationModel other)
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).other - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected int computeCurrentDefinitionHashCode()
BeerLambertLawAtmosphericAttenuationModel.checkForSameDefinition(agi.foundation.communications.signalpropagation.SignalPropagationModel) method.computeCurrentDefinitionHashCode in class SignalPropagationModelpublic void enumerateDependencies(DependencyEnumerator enumerator)
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.enumerateDependencies in interface IEnumerateDependenciesenumerateDependencies in class DefinitionalObjectenumerator - The enumerator that is informed of the dependencies of this object.public SignalPropagator getSignalPropagator(EvaluatorGroup group, IServiceProvider link)
getSignalPropagator in class SignalPropagationModelgroup - 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.public final SignalComputation getExtinctionCoefficientModel()
public final void setExtinctionCoefficientModel(SignalComputation value)
public final double getMaximumAltitude()
public final void setMaximumAltitude(double value)
public final CentralBody getCentralBody()
public final void setCentralBody(CentralBody value)