public class ConstantSolarGeophysicalData extends SolarGeophysicalData
| Modifier | Constructor and Description |
|---|---|
|
ConstantSolarGeophysicalData()
Initializes an instance of
ConstantSolarGeophysicalData
using the typical values of 150.0 for the F10.7 cm solar radio flux and
3.0 for the kp magnetic flux. |
protected |
ConstantSolarGeophysicalData(ConstantSolarGeophysicalData existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
ConstantSolarGeophysicalData(double solarRadioFlux,
double kp)
Initializes an instance of
ConstantSolarGeophysicalData from the
solar radio flux and kp geomagnetic flux. |
|
ConstantSolarGeophysicalData(double averageSolarRadioFlux,
double solarRadioFlux,
double kp)
Initializes an instance of
ConstantSolarGeophysicalData from the
average and current solar radio flux and current kp geomagnetic flux. |
| Modifier and Type | Method and Description |
|---|---|
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
double |
computeApDailyAverage(JulianDate date)
Returns the constant ap geomagnetic index value.
|
double |
computeApValue(JulianDate date)
Returns the constant ap geomagnetic index value.
|
double |
computeAverageSolarRadioFlux(JulianDate date)
Returns the constant solar radiation flux value.
|
double |
computeKpDailyAverage(JulianDate date)
Returns the constant kp geomagnetic index value.
|
double |
computeKpValue(JulianDate date)
Returns the constant kp geomagnetic index value.
|
double |
computeSolarRadioFlux(JulianDate date)
Returns the constant solar radiation flux value.
|
double[] |
computeThreeHourApValues(JulianDate date)
Returns a size eight array with each value equal to the constant ap geomagnetic index.
|
double[] |
computeThreeHourKpValues(JulianDate date)
Returns a size eight array with each value equal to the constant kp geomagnetic index.
|
boolean |
getIsThreadSafe()
Gets a value indicating whether the methods on this instance are safe to call from
multiple threads simultaneously.
|
calculateApFromKp, calculateKpFromAppublic ConstantSolarGeophysicalData()
ConstantSolarGeophysicalData
using the typical values of 150.0 for the F10.7 cm solar radio flux and
3.0 for the kp magnetic flux.public ConstantSolarGeophysicalData(double solarRadioFlux,
double kp)
ConstantSolarGeophysicalData from the
solar radio flux and kp geomagnetic flux. If you have the ap value for
geomagnetic flux use SolarGeophysicalData.calculateApFromKp(double)
to calculate the kp flux value.solarRadioFlux - The constant solar radiation flux (also known as F10.7 cm flux)
to use for both the current flux value and the 81 day centered average.kp - The constant kp value for geomagnetic flux.public ConstantSolarGeophysicalData(double averageSolarRadioFlux,
double solarRadioFlux,
double kp)
Initializes an instance of ConstantSolarGeophysicalData from the
average and current solar radio flux and current kp geomagnetic flux.
If you have the ap value for geomagnetic flux use
SolarGeophysicalData.calculateApFromKp(double)
to calculate the kp flux value.
Use this constructor rather than ConstantSolarGeophysicalData.ConstantSolarGeophysicalData(double,double) if you'd like
to use constant solar geophysical data for a time period when the current solar flux
differs from the 81 day average.
averageSolarRadioFlux - The constant solar radiation flux (also known as F10.7 cm flux)
to use for the 81 day centered average value.solarRadioFlux - The constant solar radiation flux
to use for the "current" flux value.kp - The constant kp value for geomagnetic flux.protected ConstantSolarGeophysicalData(@Nonnull ConstantSolarGeophysicalData 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 double computeApValue(@Nonnull JulianDate date)
computeApValue in class SolarGeophysicalDatadate - The date of calculation (not used).public double[] computeThreeHourApValues(@Nonnull JulianDate date)
computeThreeHourApValues in class SolarGeophysicalDatadate - The date of calculation (not used).public double computeApDailyAverage(@Nonnull JulianDate date)
computeApDailyAverage in class SolarGeophysicalDatadate - The date of calculation (not used).public double computeKpValue(@Nonnull JulianDate date)
computeKpValue in class SolarGeophysicalDatadate - The date of calculation (not used).public double[] computeThreeHourKpValues(@Nonnull JulianDate date)
computeThreeHourKpValues in class SolarGeophysicalDatadate - The date of calculation (not used).public double computeKpDailyAverage(@Nonnull JulianDate date)
computeKpDailyAverage in class SolarGeophysicalDatadate - The date of calculation (not used).public double computeAverageSolarRadioFlux(@Nonnull JulianDate date)
computeAverageSolarRadioFlux in class SolarGeophysicalDatadate - The date of calculation (not used).public double computeSolarRadioFlux(@Nonnull JulianDate date)
computeSolarRadioFlux in class SolarGeophysicalDatadate - The date of calculation (not used).public boolean getIsThreadSafe()
If this property is true, all methods and properties are guaranteed to be thread safe.
Conceptually, an object that returns true for this method acts as if there is a lock
protecting each method and property such that only one thread at a time can be inside any method or
property in the class. In reality, such locks are generally not used and are in fact discouraged. However,
the user must not experience any exceptions or inconsistent behavior that would not be experienced if such
locks were used.
If this property is false, the behavior when using this class from multiple threads
simultaneously is undefined and may include inconsistent results and exceptions. Clients wishing to use
multiple threads should call CopyForAnotherThread.copy(T) to get a separate instance of the
object for each thread.
getIsThreadSafe in interface IThreadAwaregetIsThreadSafe in class SolarGeophysicalDatapublic 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 SolarGeophysicalDatacontext - The context to use to perform the copy.