fr.cnes.sirius.patrius.forces.gravity.variations.coefficients

Enum VariablePotentialCoefficientsSet.PeriodicComputationMethod

java.lang.Object

java.lang.Enum<VariablePotentialCoefficientsSet.PeriodicComputationMethod>

fr.cnes.sirius.patrius.forces.gravity.variations.coefficients.VariablePotentialCoefficientsSet.PeriodicComputationMethod

All Implemented Interfaces:

Serializable, Comparable<VariablePotentialCoefficientsSet.PeriodicComputationMethod>

Enclosing class:

VariablePotentialCoefficientsSet

public static enum VariablePotentialCoefficientsSet.PeriodicComputationMethod
extends Enum<VariablePotentialCoefficientsSet.PeriodicComputationMethod>

Enum designating the method to compute the phase of the periodic functions

Enum Constant Summary

Enum Constants

Enum Constant and Description
HOMOGENEOUS This method does not depend on the leap years.
LEAP_YEAR This method has the advantage to have a sin function to 0 (and a cosine function to 1) every 1st january.

Method Summary

Modifier and Type	Method and Description
abstract double	computeElapsedPeriodic(AbsoluteDate date) Compute the phase of the periodic function
boolean	isLeapYear(int year) Return if the year is a leap one or not
static VariablePotentialCoefficientsSet.PeriodicComputationMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static VariablePotentialCoefficientsSet.PeriodicComputationMethod[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HOMOGENEOUS

public static final VariablePotentialCoefficientsSet.PeriodicComputationMethod HOMOGENEOUS

This method does not depend on the leap years.

LEAP_YEAR

public static final VariablePotentialCoefficientsSet.PeriodicComputationMethod LEAP_YEAR

This method has the advantage to have a sin function to 0 (and a cosine function to 1) every 1st january.

Method Detail

values

public static VariablePotentialCoefficientsSet.PeriodicComputationMethod[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VariablePotentialCoefficientsSet.PeriodicComputationMethod c : VariablePotentialCoefficientsSet.PeriodicComputationMethod.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VariablePotentialCoefficientsSet.PeriodicComputationMethod valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

computeElapsedPeriodic

public abstract double computeElapsedPeriodic(AbsoluteDate date)

Compute the phase of the periodic function

Parameters:

date - initial date

Returns:

double fraction of year

isLeapYear

public boolean isLeapYear(int year)

Return if the year is a leap one or not

Parameters:

year - year to be checked if it is a leap one or not

Returns:

boolean true if the year is a leap year. If not, return false