fr.cnes.sirius.patrius.forces.atmospheres.solarActivity

Class ExtendedSolarActivityWrapper

java.lang.Object

fr.cnes.sirius.patrius.forces.atmospheres.solarActivity.ExtendedSolarActivityWrapper

All Implemented Interfaces:

SolarActivityDataProvider

public class ExtendedSolarActivityWrapper
extends Object
implements SolarActivityDataProvider

This class is a solar activity data provider fed with:

• a user-defined SolarActivityDataProvider
• A averaged duration d

It is built with the following convention:

• It returns solar activity from user-provided solar activity data provider if date is within timespan of the user-provided solar activity data provider.
• It returns an average of first available solar data over user-defined period d if date is before lower boundary of the user-provided solar activity data provider.
• It returns an average of last available solar data over user-defined period d if date is after upper boundary of the user-provided solar activity data provider.

Since:

3.2

Version:

$Id: ExtendedSolarActivityWrapper.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Emmanuel Bignon

Concurrency :

not thread-safe

Constructor Summary

Constructors

Constructor and Description
ExtendedSolarActivityWrapper(SolarActivityDataProvider innerProvider, double duration) Constructor.

Method Summary

Modifier and Type	Method and Description
double	getAp(AbsoluteDate date) Get Ap value at given user date
AbsoluteDate	getApKpMaxDate() Get maximum date of ap / kp values
AbsoluteDate	getApKpMinDate() Get minimum date of ap / kp values
SortedMap<AbsoluteDate,Double[]>	getApKpValues(AbsoluteDate date1, AbsoluteDate date2) Get ap / kp values between the given dates
AbsoluteDate	getFluxMaxDate() Get maximum date of flux values
AbsoluteDate	getFluxMinDate() Get minimum date of flux values
double	getInstantFluxValue(AbsoluteDate date) Get instant flux values at the given dates (possibly interpolated)
SortedMap<AbsoluteDate,Double>	getInstantFluxValues(AbsoluteDate date1, AbsoluteDate date2) Get raw instant flux values between the given dates
double	getKp(AbsoluteDate date) Get Kp value at given user date
AbsoluteDate	getMaxDate() Get maximum date at which both flux and ap values are available
AbsoluteDate	getMinDate() Get minimum date at which both flux and ap values are available

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtendedSolarActivityWrapper

public ExtendedSolarActivityWrapper(SolarActivityDataProvider innerProvider,
                                    double duration)

Constructor.

Parameters:

innerProvider - underlying solar activity provider

duration - mean duration (s) for extension computation. If this duration is larger than available data timespan, d will be equal to timespan length

Method Detail

getFluxMinDate

public AbsoluteDate getFluxMinDate()

Get minimum date of flux values

Specified by:

getFluxMinDate in interface SolarActivityDataProvider

Returns:

a date

getFluxMaxDate

public AbsoluteDate getFluxMaxDate()

Get maximum date of flux values

Specified by:

getFluxMaxDate in interface SolarActivityDataProvider

Returns:

a date

getMinDate

public AbsoluteDate getMinDate()

Get minimum date at which both flux and ap values are available

Specified by:

getMinDate in interface SolarActivityDataProvider

Returns:

a date

getMaxDate

public AbsoluteDate getMaxDate()

Get maximum date at which both flux and ap values are available

Specified by:

getMaxDate in interface SolarActivityDataProvider

Returns:

a date

getApKpMinDate

public AbsoluteDate getApKpMinDate()

Get minimum date of ap / kp values

Specified by:

getApKpMinDate in interface SolarActivityDataProvider

Returns:

a date

getApKpMaxDate

public AbsoluteDate getApKpMaxDate()

Get maximum date of ap / kp values

Specified by:

getApKpMaxDate in interface SolarActivityDataProvider

Returns:

a date

getInstantFluxValue

public double getInstantFluxValue(AbsoluteDate date)
                           throws PatriusException

Get instant flux values at the given dates (possibly interpolated)

Specified by:

getInstantFluxValue in interface SolarActivityDataProvider

Parameters:

date - user date

Returns:

instant flux values

Throws:

PatriusException - if no solar activity at date

getAp

public double getAp(AbsoluteDate date)
             throws PatriusException

Get Ap value at given user date

Specified by:

getAp in interface SolarActivityDataProvider

Parameters:

date - user date

Returns:

Ap value

Throws:

PatriusException - thrown if computation failed

getKp

public double getKp(AbsoluteDate date)
             throws PatriusException

Get Kp value at given user date

Specified by:

getKp in interface SolarActivityDataProvider

Parameters:

date - user date

Returns:

Kp value

Throws:

PatriusException - thrown if computation failed

getInstantFluxValues

public SortedMap<AbsoluteDate,Double> getInstantFluxValues(AbsoluteDate date1,
                                                           AbsoluteDate date2)
                                                    throws PatriusException

Get raw instant flux values between the given dates

Specified by:

getInstantFluxValues in interface SolarActivityDataProvider

Parameters:

date1 - first date

date2 - second date

Returns:

submap of instant flux values sorted according to date

Throws:

PatriusException - if no solar activity at date

getApKpValues

public SortedMap<AbsoluteDate,Double[]> getApKpValues(AbsoluteDate date1,
                                                      AbsoluteDate date2)
                                               throws PatriusException

Get ap / kp values between the given dates

Specified by:

getApKpValues in interface SolarActivityDataProvider

Parameters:

date1 - first date

date2 - second date

Returns:

submap of instant flux values sorted according to date

Throws:

PatriusException - if no solar activity at date