fr.cnes.genopus.correlation.enums

Enum GPCorrelationType

java.lang.Object

java.lang.Enum<GPCorrelationType>

fr.cnes.genopus.correlation.enums.GPCorrelationType

All Implemented Interfaces:

Serializable, Comparable<GPCorrelationType>

public enum GPCorrelationType
extends Enum<GPCorrelationType>

Correlation type enumeration.

Author:

goesterjf

Enum Constant Summary

Enum Constants

Enum Constant and Description
CARTESIAN Cartesian correlation
KEPLERIAN Keplerian correlation
LOF LOF
NONE No correlation

Method Summary

Modifier and Type	Method and Description
static GPCorrelationType	valueOf(String name) Returns the enum constant of this type with the specified name.
static GPCorrelationType[]	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 GPCorrelationType NONE

No correlation

KEPLERIAN

public static final GPCorrelationType KEPLERIAN

Keplerian correlation

CARTESIAN

public static final GPCorrelationType CARTESIAN

Cartesian correlation

LOF

public static final GPCorrelationType LOF

LOF

Method Detail

values

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

Returns:

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

valueOf

public static GPCorrelationType 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