fr.cnes.sirius.patrius.events.detectors

Enum ExtremaGenericDetector.ExtremumType

java.lang.Object

java.lang.Enum<ExtremaGenericDetector.ExtremumType>

fr.cnes.sirius.patrius.events.detectors.ExtremaGenericDetector.ExtremumType

All Implemented Interfaces:

Serializable, Comparable<ExtremaGenericDetector.ExtremumType>

Enclosing class:

ExtremaGenericDetector<D extends EventDetector>

public static enum ExtremaGenericDetector.ExtremumType
extends Enum<ExtremaGenericDetector.ExtremumType>

Enumerate defining the type of extrema looked for.

Author:

Alice Latourte

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAX Detection of switching function maxima
MIN Detection of switching function minima
MIN_MAX Detection of both switching function minima and maxima

Method Summary

Modifier and Type	Method and Description
static ExtremaGenericDetector.ExtremumType	find(int slopeSelection) Return the extremum type corresponding to the entered slope selection
int	getSlopeSelection()
static ExtremaGenericDetector.ExtremumType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExtremaGenericDetector.ExtremumType[]	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

MIN

public static final ExtremaGenericDetector.ExtremumType MIN

Detection of switching function minima

MAX

public static final ExtremaGenericDetector.ExtremumType MAX

Detection of switching function maxima

MIN_MAX

public static final ExtremaGenericDetector.ExtremumType MIN_MAX

Detection of both switching function minima and maxima

Method Detail

values

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

Returns:

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

valueOf

public static ExtremaGenericDetector.ExtremumType 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

getSlopeSelection

public int getSlopeSelection()

Returns:

the slope selection

find

public static ExtremaGenericDetector.ExtremumType find(int slopeSelection)

Return the extremum type corresponding to the entered slope selection

Parameters:

slopeSelection - slope selection

Returns:

the corresponding extremum type