fr.cnes.sirius.patrius.attitudes.directions

Enum ITargetDirection.AberrationCorrection

java.lang.Object

java.lang.Enum<ITargetDirection.AberrationCorrection>

fr.cnes.sirius.patrius.attitudes.directions.ITargetDirection.AberrationCorrection

All Implemented Interfaces:

Serializable, Comparable<ITargetDirection.AberrationCorrection>

Enclosing interface:

ITargetDirection

public static enum ITargetDirection.AberrationCorrection
extends Enum<ITargetDirection.AberrationCorrection>

Enumerate for the aberration corrections to apply, see aberration corrections for more details about corrections CN, CN+S, XCN and XCN+S referred here under.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Apply light-time and stellar aberration corrections: From the receiver point of view (CN+S value), the resulting position vector indicates where the source "appears to be" from the observer's location (taking into account both the apparent displacement of the source during the propagation of the light arriving from it, and the observer's velocity at reception time), From the transmitter point of view (XCN+S value), indicates the direction from the source's location in which radiation should be emitted to reach the observer (taking into account both the apparent displacement of the observer during the propagation of the light transmitted to it, and the source's velocity at transmission time).
LIGHT_TIME Apply light-time aberration correction: From the receiver point of view (CN value), the source is seen where it was when light departed from it (taking into account the apparent displacement of the source during the propagation of the light arriving from it), From the transmitter point of view (XCN value), the light time aberration correction yields the observer's location as it will be when photons emitted from the source's location arrive to it (taking into account the displacement of the observer during the time of propagation).
NONE Apply no corrections at all (the signal propagation is considered instantaneous).
STELLAR Apply stellar aberration corrections: From the receiver point of view, the resulting position vector indicates where the source "appears to be" from the observer's location (taking into account the observer's velocity at reception time), From the transmitter point of view, indicates the direction from the source's location in which radiation should be emitted to reach the observer (taking into account the source's velocity at transmission time).

Method Summary

Modifier and Type	Method and Description
boolean	hasLightTime() Returns true if light-time is included.
boolean	hasStellarAberration() Returns true if stellar aberration is included.
static ITargetDirection.AberrationCorrection	valueOf(String name) Returns the enum constant of this type with the specified name.
static ITargetDirection.AberrationCorrection[]	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

NONE

public static final ITargetDirection.AberrationCorrection NONE

Apply no corrections at all (the signal propagation is considered instantaneous).

LIGHT_TIME

public static final ITargetDirection.AberrationCorrection LIGHT_TIME

Apply light-time aberration correction:

• From the receiver point of view (CN value), the source is seen where it was when light departed from it (taking into account the apparent displacement of the source during the propagation of the light arriving from it),
• From the transmitter point of view (XCN value), the light time aberration correction yields the observer's location as it will be when photons emitted from the source's location arrive to it (taking into account the displacement of the observer during the time of propagation).
  

STELLAR

public static final ITargetDirection.AberrationCorrection STELLAR

Apply stellar aberration corrections:

• From the receiver point of view, the resulting position vector indicates where the source "appears to be" from the observer's location (taking into account the observer's velocity at reception time),
• From the transmitter point of view, indicates the direction from the source's location in which radiation should be emitted to reach the observer (taking into account the source's velocity at transmission time).
  

ALL

public static final ITargetDirection.AberrationCorrection ALL

Apply light-time and stellar aberration corrections:

• From the receiver point of view (CN+S value), the resulting position vector indicates where the source "appears to be" from the observer's location (taking into account both the apparent displacement of the source during the propagation of the light arriving from it, and the observer's velocity at reception time),
• From the transmitter point of view (XCN+S value), indicates the direction from the source's location in which radiation should be emitted to reach the observer (taking into account both the apparent displacement of the observer during the propagation of the light transmitted to it, and the source's velocity at transmission time).
  

Method Detail

values

public static ITargetDirection.AberrationCorrection[] 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 (ITargetDirection.AberrationCorrection c : ITargetDirection.AberrationCorrection.values())
    System.out.println(c);

Returns:

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

valueOf

public static ITargetDirection.AberrationCorrection 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

hasLightTime

public boolean hasLightTime()

Returns true if light-time is included.

Returns:

true if light-time is included, false otherwise

hasStellarAberration

public boolean hasStellarAberration()

Returns true if stellar aberration is included.

Returns:

true if stellar aberration is included, false otherwise