public class HufnagelValleyRefractiveIndexStructureParameterModel extends RefractiveIndexStructureParameterModel
The model uses the equation Cn2 = 0.00594 * (vw/27)2 * (1e-5*h)10 * exp(-h/1000) + 2.7e-16 * exp(-h/1500) + A * exp(-h/100) where vw is wind velocity in m/s, h is altitude in meters, and A is the nominal value of Cn2 at ground level in m-2/3.
This is the Hufnagel-Valley refractive index structure parameter model taken from chapter 3 page 128 of "Optical Wireless Communications - System and Channel Modeling with MATLAB" by Z. Ghassemlooy, W. Popoola, and S. Rajbhandari
| Modifier | Constructor and Description |
|---|---|
|
HufnagelValleyRefractiveIndexStructureParameterModel()
Initializes a new instance.
|
protected |
HufnagelValleyRefractiveIndexStructureParameterModel(HufnagelValleyRefractiveIndexStructureParameterModel existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
HufnagelValleyRefractiveIndexStructureParameterModel(ScalarDependentOnServiceProvider windSpeedModel,
double groundRefractiveIndexStructureParam)
Initializes a new instance with the supplied winds speed model, and nominal ground level refractive index structure
parameter.
|
|
HufnagelValleyRefractiveIndexStructureParameterModel(ScalarDependentOnServiceProvider windSpeedModel,
double groundRefractiveIndexStructureParam,
CentralBody centralBody)
Initializes a new instance with the supplied winds speed model, and nominal ground level refractive index structure
parameter, and a central body used as the altitude reference.
|
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
checkForSameDefinition(HufnagelValleyRefractiveIndexStructureParameterModel other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(RefractiveIndexStructureParameterModel 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.
|
ScalarEvaluator |
getEvaluator(EvaluatorGroup group,
IServiceProvider serviceProvider)
Gets an evaluator that can be used to find the value of this scalar function
at a given
JulianDate. |
double |
getGroundRefractiveIndexStructureParameter()
Gets the nominal ground level refractive index structure parameter value in units m-2/3.
|
void |
setGroundRefractiveIndexStructureParameter(double value)
Sets the nominal ground level refractive index structure parameter value in units m-2/3.
|
checkForSameDefinition, enumerateDependencies, getCentralBody, getWindSpeedModel, setCentralBody, setWindSpeedModelapplyServiceProvider, checkForSameDefinition, getEvaluator, toScalarDependentOnServiceProvider, toScalarDependentOnServiceProviderareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic HufnagelValleyRefractiveIndexStructureParameterModel()
The model defaults to a constant wind speed of 21 m/s and a nominal Cn2 at ground level of 1.7e-14 m-2/3. Also, the Earth central body is used as the altitude reference.
public HufnagelValleyRefractiveIndexStructureParameterModel(ScalarDependentOnServiceProvider windSpeedModel, double groundRefractiveIndexStructureParam)
windSpeedModel - The wind speed model which computes wind speed in m/s for a given time.groundRefractiveIndexStructureParam - The nominal ground level refractive index structure parameter in m-2/3.public HufnagelValleyRefractiveIndexStructureParameterModel(ScalarDependentOnServiceProvider windSpeedModel, double groundRefractiveIndexStructureParam, CentralBody centralBody)
windSpeedModel - The wind speed model which computes wind speed in m/s for a given time.groundRefractiveIndexStructureParam - The nominal ground level refractive index structure parameter in m-2/3.centralBody - The central body used as the altitude reference.protected HufnagelValleyRefractiveIndexStructureParameterModel(@Nonnull HufnagelValleyRefractiveIndexStructureParameterModel 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(RefractiveIndexStructureParameterModel 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 RefractiveIndexStructureParameterModelother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(HufnagelValleyRefractiveIndexStructureParameterModel 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()
HufnagelValleyRefractiveIndexStructureParameterModel.checkForSameDefinition(agi.foundation.communications.signalpropagation.RefractiveIndexStructureParameterModel) method.computeCurrentDefinitionHashCode in class RefractiveIndexStructureParameterModelpublic ScalarEvaluator getEvaluator(EvaluatorGroup group, IServiceProvider serviceProvider)
JulianDate.
Adds the evaluator to the given EvaluatorGroup.
This implementation requires the given service provider to provide the ILinkService service.getEvaluator in class ScalarDependentOnServiceProvidergroup - The group with which to associate the new evaluator. By grouping evaluators
that are often evaluated at the same Julian dates, common computations can be performed only once
for the entire group instead of multiple times for each evaluator.serviceProvider - The service provider to use when calculating the value. This service provider must provide the ILinkService service.public final double getGroundRefractiveIndexStructureParameter()
public final void setGroundRefractiveIndexStructureParameter(double value)